Commit Graph

240 Commits

Author SHA1 Message Date
Jenkins 65b4090131 Merge "Add developer policy about contractual APIs" 2014-10-07 23:14:33 +00:00
Jenkins dd99a0aacc Merge "Adds openSUSE support for developer documentation" 2014-10-02 02:20:16 +00:00
Joe Gordon b70ba400ed Add developer policy about contractual APIs
Document what APIs nova considers to be public contracts, anything not
in this list should be considered a private API.

Clarify the 'API' section to make sure its clear we are talking about
the REST API.

Change-Id: If71adc7a9d5dc1bde79f75d10e67500f6f92b81f
2014-09-30 15:48:05 -07:00
Jenkins 1407d06d72 Merge "Fix hook documentation on entry_points config" 2014-09-29 17:01:13 +00:00
Jenkins c0bf2c3276 Merge "Add plan for kilo blueprints: project priorities" 2014-09-29 02:23:40 +00:00
Lars Kellogg-Stedman 1345a6a11d Fix hook documentation on entry_points config
The syntax suggested for adding hooks to nova via setup.py entrypoints is:

    entry_points = {
        'nova.hooks': [
            'resize_hook': your_package.hooks.YourHookClass,
        ]
    },

But this is incorrect. The proper syntax for an entry_points entry is:

    entry_points = {
        'nova.hooks': [
            'resize_hook=your_package.hooks:YourHookClass',
        ]
    },

Change-Id: Id7bc6891dc542d4317e82e15300c7293eb0d17a0
Closes-bug: #1374666
2014-09-28 09:29:39 -04:00
Alberto Planas a7a4932ccc Adds openSUSE support for developer documentation
Support for openSUSE documentation is updated in this patch.

Change-Id: Id238900382e574836f7832e6907a3e51d62f859d
2014-09-26 10:45:20 +02:00
Jenkins 53a88f3b0b Merge "Add plan for kilo blueprints: when is a blueprint needed" 2014-09-26 08:12:58 +00:00
kiwik-chenrui cd1d9912ca Fix Broken links in devref/filter_scheduler.rst
There were broken links on the following class
'AggregateNumInstancesFilter', 'RamWeigher' in
document filter_scheduler.html. Fix these broken
links.

Change-Id: I3cac48a6ad466a32a88c23c9f128e66dae5889ee
Closes-Bug: #1363955
2014-09-20 04:15:21 +00:00
Joe Gordon f569f0a002 Add plan for kilo blueprints: project priorities
At the nova mid-cycle we agreed that while specs have made our blueprint
process significantly better, we think the current approach still leaves
much to be desired. This document is the outcome of the discussion at
the mid-cycle on how we want to manage blueprints in Kilo.

This proposal is being placed in devref, as we want to use gerrit's
workflow (two core reviews, inline comments, revisions etc) and this is
a document for developers.

Introduce the idea of project priorities.

Change-Id: I7075a130c01be22f3ee5315d4a65b8e524b5a1ad
2014-09-17 14:13:25 -07:00
Jenkins ff78a03a91 Merge "Add sqlite dev packages to devref env setup doc" 2014-09-17 05:17:16 +00:00
Jenkins 10f36d78ec Merge "Add a policy for handling retrospective vetos" 2014-09-16 23:59:58 +00:00
Joe Gordon 995c10f613 Update devref
* Devref mentioned 10.10 instead of 14.04 as the tested ubuntu
  environment
* Point to our official git mirror instead of github

Change-Id: I4514faeaebe200a2f616bc37fca02c2927edf599
2014-09-15 20:07:18 -07:00
Nikola Dipanov 52bf71fa27 Add the NUMATopologyFilter
This patch adds the basic NUMA filter that will take the proposed
instance topology and try to match it against that of a host.

The matching will be done in the following manner:

 * Filter will try to match the exact NUMA cells of the instance to those
   of the host. It *will not* attempt to pack the instance onto the host.
 * It will consider the standard over-subscription limits for each cell,
   and provide limits to the compute host accordingly.
 * If instance has no topology defined, it will be considered for any host.
 * If instance has a topology defined, it will be considered only for NUMA
   capable hosts.

DocImpact

Change-Id: I8788dde69524c8a32a41ce31a96c89f9b09e91ce
Blueprint: virt-driver-numa-placement
2014-09-12 22:24:56 -07:00
Joe Gordon 93a7b48102 Add plan for kilo blueprints: when is a blueprint needed
At the nova mid-cycle we agreed that while specs have made our
process significantly better, we think the current approach still leaves
much to be desired. This document is the outcome of the discussion at
the mid-cycle on how we want to manage blueprints in kilo.

This proposal is being placed in devref, as we want to use gerrit's
workflow (two core reviews, inline comments, revisions etc) and this is
a document for developers.

It turns out adding the specs requirement to blueprints adds a
non-trivial amount of overhead, revisit when a blueprint and spec is
needed to minimize overhead in cases where it isn't helpful.

Change-Id: Iaaadc26f3f51ee091419beaa12e0508623eed99e
2014-09-12 15:13:38 -07:00
Matt Riedemann e65a43837e Add sqlite dev packages to devref env setup doc
While setting up a new Ubuntu Trusty development
system without devstack I ran into an undocumented
native package dependency for sqlite, so add those
here.

Change-Id: Ib82ea58e85f6ccab6008f2d19a31d0e890136ca7
2014-09-05 12:09:29 -07:00
Mark McLoughlin e48da64a15 Add a policy for handling retrospective vetos
For some time, we've been informally implementing a "revert early"
policy around handling -2 worthy complaints after a patch has been
merged. These reverts can be contentious, so it's appropriate we make
it very clear what the policy and procedure here is in order to lessen
the contentiousness of these reverts.

Co-authored-by: Michael Still <mikal@stillhq.com>

Change-Id: I90e4153a80c859a928630809aef31e7313f08906
2014-09-03 04:51:29 +10:00
Jenkins 702497d8a6 Merge "Work on document structure and doc building" 2014-08-30 15:42:48 +00:00
Sahid Orentino Ferdjaoui e31a74f560 filter: add per-aggregate filter to configure max_instances_per_host
Adds a filter AggregateIoOpsFilter which provides the ability
to read from aggregates metadata "max_instances_per_host".

DocImpact
Implements: blueprint per-aggregate-max-instances-per-host
Change-Id: I569aab7842d2c67042b89c75941a4664a599a7f6
2014-08-26 21:39:13 +00:00
Sahid Orentino Ferdjaoui 56a9512f14 filter: add per-aggregate filter to configure disk_allocation_ratio
Adds a filter AggregateDiskFilter which provides the ability to
read from aggregates metadata the "disk_allocation_ratio".

DocImpact
Implements: blueprint per-aggregate-disk-allocation-ratio
Change-Id: I79d59fcdfb09e67ed6f12113615c673624b24a19
2014-08-26 12:56:51 +00:00
Jenkins 6792cdc465 Merge "filter: add per-aggregate filter to configure max_io_ops_per_host" 2014-08-26 10:31:36 +00:00
Andreas Jaeger ea86e31a0c Fix class name for ServerGroupAffinityFilter
The class name for ServerGroupAffinityFilter is
ServerGroupAffinityFilter and not ServerGroupAntiAffinityFilter. The
wrong class lead to a wrong display on
http://docs.openstack.org/developer/nova/devref/filter_scheduler.html

Change-Id: I690a60cb70eab4837544ddd0bff6f1264e639592
Closes-Bug: #1360375
2014-08-22 20:23:24 +02:00
Matt Riedemann 6b796597d5 Add graphviz to list of distro packages to install
Commit a507d42cf5 makes the
doc builds fail on warnings, so people are probably going
to be running 'tox -e docs' more often. To run that you
need the graphviz package from the distro, so add it to
the list of packages needed when setting up a development
environment.

Change-Id: I47ffe63fddfbbd73c3fc698490ad07235caaf459
Closes-Bug: #1356983
2014-08-14 10:27:28 -07:00
Sahid Orentino Ferdjaoui 65b3a4f607 filter: add per-aggregate filter to configure max_io_ops_per_host
Adds a filter AggregateIoOpsFilter whichprovides the ability
to read from aggregates metadata "max_io_ops_per_host".

DocImpact
Implements: blueprint per-aggregate-max-io-ops-per-host
Change-Id: I086033e7904c16995298bee7196ad3e7b5dc7aaf
2014-08-14 12:40:44 +02:00
Mike Spreitzer 664868130d Work on document structure and doc building
This patch clarifies the document structure of
doc/source/devref/development.environment.rst and adds a section about
how to build the documentation.  This patch also strips out the
redundant information in doc/README.rst, replacing it with a reference
to doc/source/devref/development.environment.rst.

Change-Id: Ia354dcbaea35b812327dac7371ea2fe9aec2b594
Closes-Bug: 1268424
2014-08-07 04:26:26 +00:00
Jenkins 5278181e09 Merge "Add policy on how patches and reviews go hand in hand" 2014-08-04 21:13:59 +00:00
Matt Riedemann d441dcb2ee Update devref out-of-tree policy grammar error
The sentence structure was wrong and therefore bugging me.

Change-Id: Iac7f0803d9cc9b73075f3f0aa23e690386be71ee
2014-08-04 07:59:00 -07:00
Jenkins 571880190c Merge "docs - fix missing references" 2014-08-04 06:13:07 +00:00
Jenkins 7385b9c41a Merge "Make devref point to official devstack vagrant repo." 2014-08-04 04:01:00 +00:00
Joe Gordon 57a2dd0bf6 Add policy on how patches and reviews go hand in hand
There is currently a misconception about how a patch gets merged:
Author proposes a patch, review team reviews it. Us, and Them. Instead
it should be a 'We.'
If the review bandwidth doesn't grow at the same rate as the patch
proposal rate then we end up with a massive backlog where people are
pinging cores for reviews.

Record a recommended policy of asking patch authors to offset the review
resources spent on their patch by reviewing other patches.

Change-Id: I50653f8ea58240fa664519f544ce16b2adf39006
2014-08-04 12:04:25 +10:00
Davanum Srinivas 5830aed629 docs - fix missing references
Change-Id: Ia33fc8a3495ef6d4b929aa88efccc002616475fc
2014-08-01 11:40:51 -04:00
Matt Riedemann 44ead06927 Update devref setup docs for latest libvirt on ubuntu
Adds instructions on how to enable the ubuntu cloud-archive
and update to the latest libvirt-dev from the icehouse repo.

This is needed to run unit tests in Juno if you're still on
ubuntu precise.

Change-Id: I8c93afdd72256b2bdc487e1413bdd570a6ea59e8
2014-07-30 10:08:21 -07:00
Matt Riedemann 21bf0219f6 Update dev env docs on libvirt-dev(el) requirement
Commit 8f505b8526 added
a test requirement on libvirt-python which requires
libvirt-dev(el) being installed, so update the docs
to add that package for the distro.

Change-Id: I7169d3c78a6babe6e20c0dc35874167d0bfee922
2014-07-30 06:45:11 -07:00
Joe Gordon 05717876d5 Remove api reference section in devref
This previously just linked to api/autoindex which was removed in
I6c93f9aae1994961fdca690742398a0d540d541f (in 2011).

Change-Id: Iba86a5b84743fe6d65b797a2e9237d037c2bf1a8
2014-07-27 19:23:33 -04:00
Joe Gordon 06056c852c Deduplicate module listings in devref
devref already contains a list of all modules, so no need to explicitly
include files that just contain lists of modules under the section 'Module
Reference'. Most of the deleted files are very outdated and refer to
non-existent modules anyway.

Leave services for now as it contains some content
that should be preserved. A later patch will clean those files up.

Change-Id: I5dce1b523f3648667fcde49ee51206ae9ccfdec8
2014-07-27 19:23:33 -04:00
Joe Gordon d3d2afeeb7 Make devref point to official devstack vagrant repo.
Now that we have an official devstack vagrant repo, lets point to that
instead of my own half maintained repo.

Change-Id: I944265d18f6e796608576ea71a7983aed0ece542
2014-07-25 12:45:06 -07:00
Scott Reeve a8cb9827b7 Fix typo
Change-Id: I674512d817d44897391e62439e1730bdf89ca9b1
2014-07-22 12:18:51 +02:00
Jenkins bf1b6df322 Merge "VM in rescue state must have a restricted set of actions" 2014-07-22 08:02:17 +00:00
Davanum Srinivas 826aed0ec7 Use oslo.i18n
oslo.i18n provides the i18n functions that were provided by
oslo-incubator's gettextutils module. Some tests that were
using internal details of the library were removed.

Change-Id: I44cfd5552e0dd86af21073419d31622f5fdb28e0
2014-07-18 14:28:09 -04:00
Jenkins 233f96d031 Merge "Remove duplicate python-pip from Fedora devref setup doc" 2014-07-11 13:06:55 +00:00
Joe Gordon c5b35f5376 Add aggregates.rst to devref index
aggregates.rst was the only devref document that wasn't included in any
toctree.

Change-Id: I3e4392d2571b954d4553ca8e50b02053db4b5d99
2014-07-08 11:19:27 -07:00
Matt Riedemann d80c0eeb09 Remove duplicate python-pip from Fedora devref setup doc
This just removes the duplicate python-pip from the list
of packages to install via yum when setting up a development
environment on Fedora/RHEL.

Change-Id: I3bd0aa7230c29a97845d744f6522bd2ffd1bf130
2014-07-08 07:43:36 -07:00
Jenkins 80389939a3 Merge "minor corrections to devref rpc page" 2014-06-19 01:05:48 +00:00
Jenkins 4821d79e40 Merge "devref policy: code is canonical source of truth for API" 2014-06-18 07:59:36 +00:00
Joe Gordon f36ed48c4c devref policy: code is canonical source of truth for API
Although many reviewers know that documentation isn't the source of
truth for API behavior, we have never written this policy down before.

Change-Id: Ibe7b355947200b668324028972c121e5357a0470
2014-06-17 15:44:14 -07:00
Jenkins 92be9eea95 Merge "Shrink devref.unit_tests, since info is in wiki." 2014-06-17 11:48:09 +00:00
Joe Gordon aef9e724bb Add out of tree support dev policy
Record what our policy is around supporting out of tree code.

Change-Id: I718ef7f0b6c29a85be89292d051f07b4cdd32676
2014-06-03 15:19:22 -07:00
Joe Gordon ed3541605c Add development policies section to devref
We now have a whole bunch of unwritten development policies about what is
allowed and what isn't, it is time to write some of them down.

A subsequent patch will add the first policy.

Change-Id: I91c2eb2b937f38b3b3c5380ac93fa0ce0f5e4156
2014-06-03 12:08:18 -07:00
Leandro I. Costantino 8ff170dc95 VM in rescue state must have a restricted set of actions
Right now it is possible to pause, suspend and stop a VM in state RESCUED,
so after the state is changed, it's not possible to trigger unrescue anymore
since the original state is lost.

This patch remove vm_states.RESCUED as valid state from stop,
pause and suspend actions.

The vm_states devref is also updated to reflect this change including the
current reboot flow.( vm_states.RESCUED cannot be rebooted as per
today code)

DocImpact
Closes-Bug: #1319182
Co-Authored-By: Cyril Roelandt <cyril.roelandt@enovance.com>
Change-Id: I531dea5a5499bf93c24bea37850d562134dee281
2014-05-23 17:43:31 -03:00
Corey Wright f28e1e44a1 minor corrections to devref rpc page
Correct wording to proper English and remove extra space between words while
in there.

DocImpact

Change-Id: If4b3d9d81d7193107e84867e4ab713c413a4976d
2014-05-13 22:14:49 -05:00