Commit Graph

216 Commits

Author SHA1 Message Date
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
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
Joe Gordon a4947243d1 Dedup devref on unit tests
We already have a document on how to run unit tests, so
development.environment should just point to that document instead of
trying to summarize it.  Keeping this information in one less places
makes it easier to make sure the page is up to date (which
development.environment is not -- no mention of tox).

Change-Id: I9aecf439b6145b035b3457559ddb187058f5057b
2014-05-04 20:22:07 -07:00
Joe Gordon 3a2e65c4bf Shrink devref.unit_tests, since info is in wiki.
Don't keep a copy of the run_tests.sh flag list here since it
inevitably will get out of sync with the real list.

No need to go into detail on how unit testing is set up, since we already have a wiki
on how to run tests that applies for all OpenStack projects. Keep
section with tox examples since that is the most commonly used command.

Change-Id: Ia8eb059be164d9df3edfd69aedcebfd028da45ff
Related-Bug: 1219040
2014-05-04 20:14:38 -07:00
Alex Gaynor b055e16846 Fixed many typos.
These were found using: https://github.com/intgr/topy

Change-Id: Ia4e14508c285d95ab4eaeabbde032ecc5e7c9e4b
2014-04-25 21:47:41 -07:00
Jenkins ac84133985 Merge "Make example 'entry_points' parameter a dictionary" 2014-04-09 02:15:13 +00:00
Jenkins eb0a84a4b7 Merge "Update docs to reflect new default filters" 2014-04-08 18:43:31 +00:00
Jenkins 6dc1147d2e Merge "Fix description of ServerGroupAffinityFilter" 2014-04-08 13:45:41 +00:00
Russell Bryant 71661a9c05 Update docs to reflect new default filters
Server group scheduler filters were added to the default set of
scheduler filters.  Update the docs to reflect the updated defaults.

Change-Id: I614cf83e419c93038fc4ed7287ec743cedb4860e
Related-bug: #1303983
2014-04-07 16:46:43 -04:00
Jenkins 83b7ce96a1 Merge "Updated development.environment.rst" 2014-04-02 18:35:37 +00:00
uberj 5f31585c8b Make example 'entry_points' parameter a dictionary
Change-Id: Idad5a1b2d6aaee456cdc3a52554c1d7ddd51a696
2014-04-02 10:28:43 -07:00
Gauvain Pocentek 9a35c949b0 Fix description of ServerGroupAffinityFilter
ServerGroupAffinityFilter was used instead of
ServerGroupAntiAffinityFilter in the filter description.

Change-Id: I16721db5a7dcf90e72047dd5ca5a4f55088c147d
2014-04-02 07:37:47 +02:00
Russell Bryant 7168940296 Add a note about deprecated group filters
The deprecated group filters do not work if both are enabled at the
same time.  Add this in a note in the docs on the different scheduler
filters.

DocImpact
Related-bug: #1296913

Change-Id: Ic0e1b8b59c8a462e193dffb3b0f873d8aa35aa3c
2014-03-28 11:52:19 +00:00
Russell Bryant 2bca0c9011 Add new style instance group scheduler filters
Prior to Icehouse, there was a different type of handling of the
'group' scheduler hint that got lost in the completion of the server
groups API.  This patch completes the code necessary to provide
backwards compatibility with the old behavior.

Previously, the policy for groups was simply based on what scheduler
filters you had enabled.  You could have either the affinity or
anti-affinity filter enabled and that would be applied to all groups.
These filters now act on groups with a policy type of 'legacy'.

New filters have been added that can be enabled simultaneously and act
based on the policy set on the group via the server group API.

DocImpact

Change-Id: Ia65c151396415ca48725cb3c756f33efa01d2fe5
Closes-bug: #1296913
2014-03-27 21:54:02 +00:00
Pranav Salunke eb92d42536 Updated Setting up Developer Environment for Ubuntu
I saw that there are a few libraries which are required but not
mentioned in the docs.

Change-Id: I47036bb85c1b4c617f14d7534c204df474439513
2014-03-25 18:13:53 +05:30
Jenkins 999d9273f4 Merge "Add doc update for 4 filters which is missing in filter_scheduler.rst" 2014-03-21 16:51:33 +00:00
Jenkins 0b4c179fdd Merge "Noted that tox is the preferred unit tester." 2014-03-19 04:23:40 +00:00
Jenkins b9a9585875 Merge "Fix typo in devref" 2014-03-08 17:10:50 +00:00
Mike Spreitzer f2e06994a5 Noted that tox is the preferred unit tester.
This bug and fix is not about deleting run_tests.sh.
The change to delete run_tests.sh has been abandoned.
Thus the documentation of run_tests.sh remains.

Change-Id: Ia0a883260affc56c148dbebc5e3a49acb36b067e
Closes-Bug: #1282393
2014-03-08 02:47:38 -05:00
Mike Spreitzer 1ad28b5a02 Updated development.environment.rst
Enhanced the discussion of tools/install_venv.py to say that it
installs the items listed in test-requirements.txt as well as
those listed in requirements.txt.

Re-wrapped the relevant paragraph.

Since the change to delete run_tests.sh and tools/install_venv.py
(https://review.openstack.org/#/c/76627/)
has been abandoned, the doc of install_venv.py should still be
accurate.

Change-Id: I5cfd9f179f40b2418129067d0940bfdbf47512cb
Closes-Bug: #1266671
2014-03-08 02:21:59 -05:00
Dan Smith 226fd5080b Fix development environment docs for redhat-based systems
This adds the new libffi-devel dependency to the devref for new
development environment creation.

Change-Id: I63e0302cffe33b05722579e7d9c7122f2f257843
2014-03-05 16:12:11 -08:00
Sahid Orentino Ferdjaoui 5e5000b142 Fix typo in devref
s/differenet/different

Change-Id: I06bb0d9b0c5448ec5491372572e2b98dc3cea9be
2014-03-05 09:36:10 +00:00
jichenjc 35637ff218 Add doc update for 4 filters which is missing in filter_scheduler.rst
DiskFilter
NumInstancesFilter
IoOpsFilter
PciPassthroughFilter
are missing in doc/source/devref/filter_scheduler.rst, add them.

DocImpact

Change-Id: I50868598c9769783e1677c9ec50abf031896af82
Closes-Bug: #1276575
2014-03-05 04:42:54 +08:00
Jenkins 93f059b492 Merge "Introduce Guru Meditation Reports into Nova" 2014-03-01 02:39:11 +00:00
Solly Ross cec532848f Introduce Guru Meditation Reports into Nova
This commit integrates functionality from the
`openstack.common.report` module into Nova.
This enables Nova services to receive SIGUSR1
and print a Guru Meditation Report to stderr.
The required modules were added to
'openstack-common.conf' as well.

Change-Id: I224a426dad084f0e738069207ffbffe7f7935a17
Implements: blueprint guru-meditation-report
2014-02-24 19:24:41 -05:00
Russell Bryant e7e200907a Update ubuntu dev env instructions
I just set up an environment to run unit tests on Ubuntu and had to install a
couple of additional packages to make it work.  Update the instructions to
reflect that.

Change-Id: I2ceb1b130111991fa1b34b4636b8ece115e54084
2014-02-24 11:37:01 -05:00