Whenever someone asks about v2 vs v2.1 vs v3 API and I point
to the docs, I also point to the Liberty summit session which
is good for new people to watch before trying to sort through
the docs and code, so add a link to the high-level section
of the docs.
Change-Id: I34d734454afcfdae3f874160dfd11662e61c2faa
The docs had references to https://docs.openstack.org but this
website is http only. Connecting to the https address results in
an unable to connect error.
Replacing with http also makes it consistent with all other references
to docs.openstack.org.
Change-Id: I5367bb623aff33148cceadbdcb8df3550f655ed4
Commit bd7e62f796 disabled the
autodoc_index_modules flag for building docs but it wasn't really
necessary, that change was just to get the module index out of the main
docs page.
We want to autodoc the modules so we can view the actual module index in
the tox -d docs build results, which also tells us if we have correct
ReST format in doc strings.
Notes
-----
1. Several doc string blocks have to be fixed as part of this to get
the docs tox job to pass.
2. A docstring in vhdutilsv2 is updated to remove the math directive
since that requires the sphinx.ext.pngmath extension which requires
latex and dvipng packages from the distro - which is overkill for
what the docstring was actually doing with the math directive.
3. We exclude autodoc for tests since we don't really care about
docstrings on unit tests.
4. We exclude the nova.wsgi.nova-* modules since those won't build with
autodoc since they can't be imported (there is no
nova/wsgi/__init__.py module). We could arguably add the __init__.py
but it's not really necessary for what those scripts are used for.
5. The sphinx.ext.ifconfig extension is removed since there are no docs
that use the ifconfig directive.
6. Update the developer docs to explicitly point out that graphviz must
be installed prior to running tox -e docs.
7. Hide doc/source/api/autoindex.rst from the toctree so that we don't
regress the point of commit bd7e62f796.
8. unused_docs and exclude_trees options are removed from conf.py since
they are deprecated in Sphinx 1.2.3:
https://github.com/sphinx-doc/sphinx/blob/1.2.3/sphinx/config.py#L54
9. Fix imports for moved libvirt volume options.
Closes-Bug: #1471934
Change-Id: I946e2f89f2c9fc70e870faaf84e4a8b0fc703344
This commit adds some (long overdue) documentation around block device
mapping and how it's used in Nova.
blueprint devref-refresh-liberty
Change-Id: Idca142f3b34ad896ab99f02a3f9eb72a6a3b4778
The "group" tag on nodes can be used to create vertical alignment, all
nodes in a group which are connected will end up in one column. This
makes reading the flow chart a bit easier.
Add a " " before the "no" edges otherwise they are left justified
completely to the vertical edge, and make it kind of gorpy to read.
Change-Id: Ife11e905ea6fdd97e1459fbbc001324eb946f9e4
As Parallels Cloud Server product was renamed within Parallels company rebranding
we need to change its reference in feature support matrix and documents accordingly.
A parameter 'virt_type' in libvirt section of nova.conf will remain 'parallels'.
Since libvirt version that supports 'vz' starts to report it as a hypervisor type,
we add a new hv_type 'vz' in the list of known hypervisors.
DocImpact.
Change-Id: I536e4284927508a813edd05f185f7ba0ed76d38c
implements: blueprint rename-pcs-to-virtuozzo
We log a warning when using cells that it's experimental, and we have
several locations in the docs that say it's experimental, but we have
never documented that rolling upgrades are not supported and that cells
deployments must be upgraded in lockstep. This adds that information to
the warning that's logged on startup and to the devref doc on upgrades
so people know that cells is still a special kitten that must be treated
differently.
Related-Bug: #1479181
Change-Id: Idd57f8daa308543a1733092f427e41b1a205b1d1
Adding docs to make it clear how to get more involved.
As a first step, lets link to the docs we are working on in the wiki.
At a later date we can graduate the wiki docs into here.
blueprint devref-refresh-liberty
Change-Id: If6c24bc4522eab72354c1602ceaa07352104a34d
This documents what we consider the contract in Nova, and what kinds
of things trigger needing a new microversion. It also includes a flow
chart for folks that are more visually inclined.
Change-Id: I6dbadbf7cb23e27b96a0ae191419c8adf6ffe006
The libvirt Xen driver is partially supported, since it supports cold
snapshots, but it is said that the feature is missing. Changing it and
adding a note.
TrivialFix
Change-Id: Ie8b5c006129df4638f34b7c1fada5fc18ad672c7
The Guru Meditation Reports has graduated from oslo-incubator, Nova
should switch to use oslo.reports to keep the code base clean.
Change-Id: Ifc35c9e5455eb965e4520438284cf7baa0a00d43
Blueprint: graduate-oslo-reports
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 feature that was previously labeled as "evacuate" was in fact the
"host maintenance mode" which was triggered via a different API.
The real evacuate feature (with the evacuate API) is added by this
patch set.
http://lists.openstack.org/pipermail/openstack-dev/2015-June/067787.html
Change-Id: I525fa04f4b85cbe6af5b779c81d861fd56c0852f
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
Matt Riedemann