Nova v2.1 API validates a request with JSON-Schema, and there are
some specific usage on that. This patch adds it to the rst file
for the implementation hint.
Change-Id: I4edac8b6b53d198f2a237bb163b8975528319c9b
The commit Ic19f2d019c2c78f1de14a0eced85e84f2d2cec28 has changed
API directory structure, but we forgot to update the corresponding
doc. This patch updates it.
Change-Id: Ie287fc99a6b9b30befa09b7a30226ac6460ad612
Added a set of schema and data migration policy rules to the `upgrades`
devref document to facilitate live upgrades.
Change-Id: I4e38a228b38927115bb13652966d45f250cc2af6
As the API validation code always return 400 when request with
invalid json body, so 400 is an available status code for all the
Nova API. Then no microversion bump required for fixing 500 to 400.
Change-Id: I0454e95cd0655c910fad8b39ead2b5edab216b68
Related-Bug: 1471239
Change Ia782ab9d9a31d37854606f7be82582de6d7bc374 returns a 403 rather
than a 500 for OverQuota and adds that to the list of expected errors in
the v2.1 case.
There is no microversion change required since the 403 case is implied
given keystone authentication can fail with a 403 on any API.
This change updates the docs to mention the exceptional case for 403.
Related-Bug: #1444559
Change-Id: I7ea8c5c50d4eac53837f5f76e09277ac185288a9
We shouldn't require a microversion bump for translating a 500 error to
some 400-level error code since 500s should not be part of the API
contract and clients shouldn't expect them for cases that the client can
change, i.e. don't ask for things that don't exist, don't ask to do
things that raise quote and you're already maxed out, etc.
There was some confusion in the doc about the statement that a
microversion is needed when changing from a 501 to a 400, but that's a
different case (going from something not being implemented to it
suddenly being implemented - that's a case where the client should
opt-in and a microversion bump is required).
Not returning 500s is just fixing bugs and shouldn't require a
microversion, the docs even already say that in the first footnote -
this just adds notes to clarify.
Also fixes the links to the [1] footnote.
Change-Id: I4526a72458a23662bd8aaa7f89be32844a511929
The old peer code review wiki has been replaced by the infra dev manual
for peer review, so update the link in our docs.
Change-Id: Ib84e2e10e32a2328d9252c86b539b1b40830761d
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 bd7e62f796fe951fd42c2edad56e252a0b7393c8 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 bd7e62f796fe951fd42c2edad56e252a0b7393c8.
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
