Reorganized the developer docs so its clear between whats are future
plans and what things are documenting the current behavior.
Given a lot of the API docs are currently in flux, I have classed those
as future plans.
blueprint devref-refresh-liberty
Co-Authored-By: Michael Still <mikal@stillhq.com>
Change-Id: Ie79fcef909487ee1797274f0ca23854b2fb49d32
The diagrams were hard to read and update. Replaced them with
simplified diagrams and tables. I used the content as is. I looks
inconsistent to me, but should now be easier to change.
Partially implements: blueprint devref-refresh-liberty
Change-Id: I707e1a6ab69ef44448b66e8be007307b5d73eb06
architecture.svg diagram was generated using dia
(http://dia-installer.de/) and can be found in image_src
This is an attempt to show the same information as previously found in
the ascii art.
blueprint devref-refresh-liberty
Change-Id: Iab5811bcc7ec4b3fa457a07d33a0373ba95723ca
The "serial console" feature was introduced during the Juno cycle
and is an alternative to remote access via VNC, RDP, SPICE for
platforms which don't support these.
This change adds a new feature row for that to the hypervisor support
matrix table. Because I'm not able to make a statement for all
hypervisor targets I use the "unknown" state for them.
Change-Id: I23381e30b6ddb823a50f7755179eb02bc18222e8
Some features could be made clearer if the CLI commands which are
related to that feature are listed. This patch set allows to set
CLI commands per feature.
This is an interim solution until the new feature classification
system is established.
Change-Id: If599627187080a8349811f50f6561e9efbc35138
Misled by the title of the feature "evacuate" the platform s390x
marked it as "complete". After a discussion in Nova IRC channel it was
clarified that this should be called "set host maintenance". This is
"missing" for s390x just like on x86. hyper-v doesn't implement the
necessary methods too.
http://lists.openstack.org/pipermail/openstack-dev/2015-June/067787.html
Change-Id: I3cd386269868c9fbbdbb16ca6281a86f4e2f1e0f
This patch adds the describe how to separate plugin when adding new
resource or some extended for existed resource.
Change-Id: Ib356aa9df0a3b85580ea2869ce4d043a6850967a
- Changes api to API to force build of all source files.
- Ensures tracking is consistent across all openstack.org web properties.
- Tracks only docs.openstack.org/developer/{{ project }} where
project name is taken from conf.py.
- Removes ability to build local without GA. If you have ideas
for how to build local without GA, please patch.
Change-Id: Ibb61e5c1668e6a0782daf91d4faf0950c5bf77d7
Partial-bug: 1441315
This document describes the expect of Nova REST API from Nova team. Also can
resolve some confuse what you see in the current Nova code. The Nova team will
try to reach the final goal of this document described.
Co-Authored-By: Jay Pipes <jaypipes@gmail.com>
Change-Id: Ia837bca561fa8a7c48eadfcd9bd791dc8c8d29ac
Listed the current process for upgrading the Nova database to allow for
better understanding of what will be changing.
Change-Id: Ib1c6abd8b08fe0987e2535d0ed6729f5384cebf3
Signed-off-by: Philip Schwartz <philip.schwartz@rackspace.com>
When a new feature gets added to the hypervisor support matrix it
was not possible to state that the hypervisor did not make a support
statement yet. You had to choose between "complete", "partial" and
"missing" wich could be missleading.
This change set adds the status "unknown" which could make the
statements more precise.
Change-Id: If94fc772796742de88af5893839945834b9d3eb6
Make the API microversion history more accessible by adding it to nova's
doc landing page.
Making sure it is easy to discover what the difference between each
microversion is fundamental piece of the microversion puzzle, so lets
not require end users to have to look through git.
rename api_microversions.rst to api_microversion_dev.rst to clarify that
it is about development and versus history.
Change-Id: I270944bf9739b113a43b932948fdbf83e449603b
This change allows the AggregateTypeAffinityFilter to function when
multiple instance_type names are set in the Aggregate Metadata.
This change implements and documents a new comma separated syntax for
the aggregate instance_type metadata attribute. The legacy syntax is
still supported when a single instace_type is specified.
e.g. 'm1.nano' or "m1.nano,m1.small"
DocImpact
Change-Id: I0618a300754d012db62df52faa12cc3cedfe2b65
Closes-bug: #1399204
Previously kilo.blueprints was a document to propose a change to the
blueprints process. Turn the document into a reference for blueprints,
specs and priorities in nova.
* Just state current policy instead of references to how it was
before. This information will still be around in the git history if we
never need to look it up.
* Now that we have been doing this for a cycle we don't need hypothetical
examples anymore.
* Make this reflect the fact that we just use an etherpad to track
* priority reviews.
Change-Id: I0d6e568fe1a8ef40de1d7f7d7e45260b1400e407
All of that information can be found at
http://docs.openstack.org/infra/manual/developers.html, so just make the
link to developers.html more prominent in development.environment
* Rename development.environment to a shorter title, Developer quickstart.
Change-Id: I1460e6c86a7e0a1efb4a81c6c5cb594476171214
* Just point to dvstack docs
* Don't go into advanced tox features like '--notest' and how to source
a env that tox builds. These are beyond setting up your environment.
And are not very nova specific.
* Don't show how to build man pages, they are very out of date and
mostly useless anyway.
* Drop 12.04 based install instructions
* We don't need libvirt-dev to run unit tests anymore
Change-Id: I3fab352e2d9d7cb64ebfe2603ec658768fdd0e44
The libvirt NUMA testing docs were written before the final code
was merged, so the example JSON shown for the database fields
did not match reality. It was also hard to read the JSON since
there were no line breaks & indentation. To make matters even
worse, the final example was just plain wrong - the data shown
was a mixture of a guest with 1 NUMA node and a guest with 2
NUMA nodes.
Change-Id: I51e4df2d9fe252ba65f6a37d84f125e18b44e239
- The spec is now implemented instead of approved.
- The samples should pass the pep8 test.
- Make sample code use consistent variable names.
- Add a note about which tests may need updates when creating a new
microversion.
Change-Id: I6796b7e055322647e2cae2d993d79a4b1cacc70c
With commit da9301fbc the live-migration is possible for "libvirt KVM
(s390x)". This patch set updates the hypervisor support matrix for the
features "live-migration" and "evacuate" (which can use live-migration).
Change-Id: I17ef7012222c7088fa0ae750d06805e5254b1cf5
* Explain these docs are for trunk (copied from ironic)
* All the docs in this repo are meant to be developer docs, so having a
devref inside of the docs is redundant and just makes the docs more
complicated to navigate. Move everything out of the devref folder and
link to everything from main index.
* Move man pages into separate section. The man pages are pretty sparse
* right now, we should either make them useful or just delete them
* Remove dead docs from unused_docs list in doc/source/conf.py
* Shuffle docs landing page, move common referees to the top (API,
hypervisor support matrix), Add a introduction section and more. The
hope is the updated layout makes this document easier to navigate.
* Use maxdepth of 1
* Rename a few sections with what are hopefully better names
The next step is to prune out outdated documents and further cleanup
this page.
Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
This is developer oriented documentation, make sure that is clear and
point to docs.openstack.org for more docs.
Change-Id: I0680e331b0fcf57dddb157c99e59d690fea349cb
This adds a document that helps clarify the scope of the Nova mission
statement.
We need to keep the Nova project a manageable size. Agreeing on what
Nova should focus on is a great way to make sure we grow Nova in a
consistent way, leaving open opportunities for other projects to do a
better job of things Nova doesn't see as part of its core mission.
Part of blueprint devref-refresh-liberty
Change-Id: I4e46ee252e6b29b063bcc8204d60d670eb79daef
Our docs our wildly out of date and pretty bad, this is a first step at
beginning to clean them up and make them more useful.
* remove the guidelines section. 2 of them are explicitly wrong (API
Compatibility and Open Standards), and no one actually uses these
guidelines during development. Yes we want high availability and fault
tolerance, but listing these design guidelines here is misleading at
best.
* Don't explain how this document is built, don't need to explain that
so prominently
* Update the intro based on Nova's mission statement
Change-Id: Ia564a7cacdac0ddab913464ca1c7f9fefb0ee0b5
taked is not a word, corrected typo
especially was spelled wrong - typo corrected
specfied was also corrected to specified
Change-Id: I6e36fe4f2ef3d4d0357ced607ae4401c78e0741a
The toctree was globbing a nonexistent directory, and not producing
useful output. This patch lists the contents correctly.
Change-Id: I414120d948bd3eeeec84ac279bab11c276ef5eee
ComputeCapabilitiesFilter will fail to pick a host if used
along with AggregateInstanceExtraSpecsFilter. This fix will at least
warn the users that they shouldn't use the two filters together.
Change-Id: I98b1eef6484bffc4305ff84e8badbde7992132ed
Fixes-Bug: #1279719
John Garbutt