20 Commits

Author SHA1 Message Date
Jim Rollenhagen
56632fc75d Fix override-defaults in plugin docs
Docs specify that this file should be override_defaults, when really
devstack looks for override-defaults.

Change-Id: I3900ec4d16ffb48c6969dac5081ea2817536c246
2015-12-10 05:57:19 -08:00
Deepak C Shetty
93e2499ee1 doc: document override_defaults phase
override_defaults phase was added to devstack in [1]
but documentation was pending. This patch adds the
same. For history around override_defaults, one can
refer to the mail thread [2]

Also fixes a small typo

[1]: https://review.openstack.org/#/c/167933/
[2]: http://lists.openstack.org/pipermail/openstack-dev/2015-March/059621.html

Change-Id: I1b58ca0ce0e4b85a1dbd710b4c426606fd4dcf45
2015-11-18 12:43:54 +05:30
Zhang Jinnan
9f6b542a25 change stackforge url to openstack url
beacuse of the stackforge project move to openstack project,
so change the document url to git://git.openstack.org/openstack/.

Change-Id: I1628c0aeb62ee519867fdaee56386e22978c4271
2015-10-20 11:49:18 +11:00
dieterly
bf9f9a5942 Fix typo
Change 'This' -> 'These'.

Change-Id: If2f8f92d3adbb8fe4556e5c3ec53e4da31d02d49
2015-09-21 13:24:00 -06:00
Atsushi SAKAI
2040143409 Fix four typos on devstack documentation
behaviour => behavior
mechansim => mechanism
glustfs => glusterfs
pluggin => plugin

Change-Id: I3de6740e5d4b2b55009614007767458124036b75
Closes-Bug: #1478538
2015-07-27 20:43:59 +09:00
Chris Dent
dcc8a30f2a Be more explicit about jenkins project config
In documentation like this (which is a huge boon) we should strive to be
as explicit and helpful as possible, so this change tries to be more
clear about what a project.yaml is and where one might go to create it
or change it.

Change-Id: Ia66a361fc7d79e511afa3ad903fffb122b86998b
2015-06-27 12:45:21 +00:00
Sean Dague
0124e08ede refresh the devstack plugin docs, add plugin registry
The devstack plugin docs mostly referred to in tree plugins, which is
honestly something we don't want people doing. Instead restructure the
whole document to talk about external plugins as the only kinds of
plugins, and focus on a workflow to make that easy for people to work
through.

This also adds a plugin-registry page to start listing known plugins
somewhere centrally. Some sample content was added, hopefully people
will submit patches to include their plugins.

This does drop the section on hypervisor plugins. That's not currently
something that we expect a ton of people to work on, so diving into
the code for this should be fine.

Change-Id: Ifc0b831c90a1a45daa507a009d1dcffcd6e2deca
2015-06-19 08:48:16 -04:00
Ian Wienand
51c48d4c80 Add a note on default values of globals
Add a note on default values of globals in plugin settings

Change-Id: I0d5d3a7e0597abe7e2401f8bae30ccc5682eab03
2015-03-25 21:52:14 +11:00
Jenkins
d9a7ae8056 Merge "Allow devstack plugins to specify prereq packages" 2015-03-19 00:35:34 +00:00
Adam Gandelman
7ca90cded3 Allow devstack plugins to specify prereq packages
We offer main devstack components the ability to install their own
system package preqreqs via files/{debs, rpms}/$service.  This adds
similar functionality for plugins, who can now do the same in their
own tree at ./devstack/files/{debs, rpms}/$plugin.

Change-Id: I63af8dc54c75a6e80ca4b2a96c76233a0795aabb
2015-03-11 14:46:35 -07:00
Jenkins
d8b66662d5 Merge "Document use of plugins for gate jobs" 2015-03-10 13:25:16 +00:00
Ian Wienand
db1152c96e Document use of plugins for gate jobs
Document use of plugins for gate jobs.  See also [1]

[1] http://lists.openstack.org/pipermail/openstack-dev/2015-January/054291.html

Change-Id: I9ed82f5d195511fb612517745f93f2a54475091a
2015-03-10 07:12:15 -04:00
Sean Dague
33127a1287 update plugin doc
After doing a couple of external plugins I found that basically things
don't work unless you enable_service in the settings file. Document
that as a requirement, and clean up the rest of the docs around the
external plugins to be consistent with that.

Change-Id: I13aee7dbf112ce9663e8338b555a208327f89b61
2015-02-09 15:17:27 -05:00
YAMAMOTO Takashi
b1a153ed71 plugins.rst: Fix a typo
Change-Id: I3f85166a1e0f2fea02055dae6871746ad1b8d897
2015-02-09 12:43:12 +09:00
Sean Dague
2c65e71ab8 Implement devstack external plugins
This is an initial pass at plugin infrastructure for devstack which
allows specifying an external repository via:

enable_plugin <name> <giturl> [branch]

It implements the devstack specification for this at
I173dee3d57967b1d2ffd30e4868a2832aeac97ce

Change-Id: I8e4175313b3cf0b12e981122358b1288a7eb0746
2015-01-06 12:30:25 -05:00
Sean Dague
3293046d30 use a more common rst header hiearchy
While rst doesn't actually care about the order of headers, reviewers
sometimes do. And the build in emacs mode has a certain order
specified that it can easily rotate between.

Standardize on == h1, = h2, - h3, ~ h4 in the code.

Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
Dean Troyer
ea3cdfad1f Pass through the rest of the docs
Do the link cleanups and update a handful of things that were
out of date.

Change-Id: I758027bf3577c66cfb13df963516823a5c247080
2014-11-08 08:29:20 -06:00
Dean Troyer
0986a7b760 Remove old HTML headers
Change-Id: I39107df88aeb89d3364ad479d8c313b7a79b9440
2014-11-06 06:40:45 -06:00
Sean M. Collins
0f3bafc74e Remove copyright footer from RST docs
Change-Id: I2fe6aac7caec21af26983636d6ec827b3525ee15
2014-10-24 10:48:46 -04:00
Sean M. Collins
09e550c370 Convert all HTML doc to RST
The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-22 12:27:00 -04:00