Adds a first cut for some documentation on how to write an API plugin
for V2.1. Note that this is not meant to have exhaustive coverage, and I
will add more detail in future commits. I do welcome suggestions of
other areas which should be included in future doc patches.
Partially implements blueprint v2-on-v3-api
Change-Id: Ibe5a471af357ce21253efeb8beb9ade1c16396f5
As patches are being added which use the new microversions
framework, it will be useful to have some guidance for developers
on how to use it.
Partially implements blueprint api-microversions
Change-Id: I6a118388a436e6ea0a3fdcb998f7a7ba4fbf6e8f
Introduce a new section in the developer documentation that
is a place to put manual testing guides. As a first testing
guide, document how to test the recent NUMA support in
libvirt using nested KVM and virtual NUMA.
Change-Id: I9b4d823b72593b0e72291f6eadef4c796efd1242
This adds some initial information on the cells v2 effort into the
devref. We start by adding a manifesto explaining what we are trying to
accomplish.
Change-Id: Iff050e0fc9790c945f6a946d0d415ea72b40642f
Co-Authored-By: Dan Smith <dms@danplanet.com>
There are several improvements for nova rest API policy. And we
should have a full view for them to make sure we are on the right way.
This docs aims to describe the improvement from blueprint v3-api-policy
and separated-policy-rule-v3-api.
Change-Id: I34a37475f2b18607fc9453764e675113c4ab773b
The internationalization devref was out of date (and wrongly named). This
patch documents the current advice for internationalization.
Change-Id: If91b3b11c4050cb231b7d9c38b6beca8ba6ce236
This covers the plan for zero downtime upgrades. It looks at all the
building blocks we have in place, and a few we have planned for kilo and
pulls that into a process that we hope will deliver zero downtime
upgrades.
This is just an initial stake in the ground to help drive the upgrade
efforts during kilo.
Change-Id: I3974d18f79ba655257dcac49208821bc191d8cc5
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
This previously just linked to api/autoindex which was removed in
I6c93f9aae1994961fdca690742398a0d540d541f (in 2011).
Change-Id: Iba86a5b84743fe6d65b797a2e9237d037c2bf1a8
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
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
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
This patch contains a number of cleanups of the nova devref,
mostly related to outdated content.
1) remove outdated todo items from network
=> these have been long covered in the manuals
2) remove outdated multinic docs and images
=> this is now better covered in:
http://docs.openstack.org/trunk/openstack-compute/admin/content
/using-multi-nics.html
3) remove outdated cloudpipe docs, confs and scripts
=> This is now better covered in:
http://docs.openstack.org/trunk/openstack-compute/admin/content/
cloudpipe-per-project-vpns.html
4) remove outdated networking docs
=> These were marked as 'legacy' more than 2 years ago
Change-Id: I9321335031b4581c603a6f31c613e1b620d468a6
Hooks add the ability to insert custom code around operations that
declare a named hook:
e.g.
@hooks.add_hooks('create_instance')
def create_instance(....):
....
The above hook allows Hook objects to be run 'pre' and 'post' the
execution of create_instance()
Hook objects are discovered via the setuptools entry point group
'nova.hooks'.
Change-Id: I3961df12ef415085de7459438967edacc34500c2
This removes the majority of the nova-volume code from the codebase.
It updates relevent config options to default to cinder. It updates a
number of existing tests that were depending on code that was removed.
A few things still need to be removed:
* volume/driver.py & volume/iscsi.py
These files are used by the libvirt volume driver tests. These
tests should be updated to mock the relevant calls.
* scheduler/simple.py & scheduler/multi.py
These files should no longer be necessary so they can be removed
in a subsequent patch
* exception.py cleanup
Once the above files are removed there are a number of unused
exceptions which can be removed
* database calls and database tables
The database calls have not been removed and the tables have not
been dropped. This can be done in a separate migration
* additional config options and nova.conf.sample
There may be a few extra config options that can be removed and the
conf sample can be regenerated
Implements bp delete-nova-volume
Change-Id: I0b540e54dbabd26901a7530035a38583bb521fda
Added diagrams to RST docs that show required vm_state / task_state
transitions for compute api operations.
(Set Sandy Walsh as author since he created the diagrams)
Change-Id: Ie6a9cd4b54321a98fea5429ee52eb781f57f31a4
Now that the rpc API includes more than RabbitMQ, update a filename and
directory name to be 'rpc' instead of 'rabbit'.
Change-Id: Ib7fcccdd77fae128b6de3ee490fee3d6325ca7c5
blueprint sphinx-doc-cleanup
bug 944385
- Fix formatting and markup issues that produce error messages
- Update TOC lists for missing/new files
- Fix a few links
- Update instructions with dependencies for building the documentation
- Updated base on review comments from oubiwann to fix trailing whitespace in modified files
Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
Documented how to run unit tests
Added docs about what's on Launchpad
Added docs on Gerrit with pointers to wiki.
Added docs on Jenkins: how to access, what it does
Clarified that running unit tests doesn't mean you can fully run OpenStack.
Change-Id: I33fa9d2f271631a1a9aceaa5d4fd465198bf51d4
* quieter build (fewer warnings)
* move api reference out of root directory
* auto glob api reference into a TOC
* remove old dev entries for new-fangled auto-generated docs
Chris Yeoh