This document previously existed to explain how to use either
application/json or application/xml with Nova. It's mostly confusing
in it's current state, and we're correctly defaulting to
application/json on request and response now.
Just remove most of what's confusing, users don't need to send
headers, we only do one thing now.
Change-Id: I597aeab73f1075f400f053016b4ea7bda01893a5
XML API interface has been already removed from Nova completely,
and its description of the extension concept becomes meaningless now.
So this patch removes it.
A small amount of the JSON description is left. The details are
trimmed down, as we're actually trying to get people away from
extensions as a concept.
A big warning to that effect is added into the document.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: Icf8bf87f38733ba03cf5ce1225594b0b282fde56
there is no method on 'BAK extension appended with a time stamp'
if this comes from some Active engine, we should let active
engine to document it instead of generialize it in nova
blueprint complete-todo-in-api-concept-doc
Closes-Bug: 1525137
Change-Id: Ibb05dc57f9be81de335ca4935c4c7fa59971de13
nova allows injections of zip or binary files, the doc
should not say 'You cannot inject binary or zip files into a new build'
blueprint complete-todo-in-api-concept-doc
Change-Id: I09b80268545ea0071946aefd3a566441296436ec
Closes-Bug: 1525132
Add hypervisor brief description on its concept and
how nova offer the ability to admin to interact with it;
Also add description for migraitons.
There is a doc about aggregates, so put the link
in general_info.rst.
blueprint complete-todo-in-api-concept-doc
Change-Id: I61f6999be62e3e689ca9bf8b28b08f6a0b4aa9df
For compute-api set the launchpad project users report bugs
against to "nova". Users can report bugs using the "bug icon" that will
directly link to the launchpad project, it currently goes to
"openstack-manuals" which is wrong for this content.
This variable is used by openstackdocstheme 1.2.6.
Closes-Bug: #1524476
Change-Id: I08ba11bb1c5388bc4611cea581274ac5d724c8d9
We have multiple concepts for configuring guest os. This patch
adds separated section for them, just like the 'move servers' section.
blueprint complete-todo-in-api-concept-doc
Change-Id: Ibbffdb00d1529a386f338da4776eb614891731c8
We should describe extra specs and image properties in concept doc
This patch add separated section for it.
blueprint complete-todo-in-api-concept-doc
Change-Id: I092c15c82666eeb113485aee3ea878888d6eaf2d
No substantial changes; just wanted to make the text sound more like
native English.
blueprint complete-todo-in-api-concept-doc
Change-Id: I9ff48113bf709f63e3654a5851aa8d6853b519b5
As the folloing content of etc/nova/api-paste.ini, legacy v2
endpoint is /v2, not /v2.1.
/v1.1: openstack_compute_api_v21_legacy_v2_compatible
/v2: openstack_compute_api_v21_legacy_v2_compatible
/v2.1: openstack_compute_api_v21
So this patch fixes the endpoint.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: I6d9346ced38f522c516778cadae217d1d5c9cff1
The concept doc should only talk about v2.1 API. This pach corrects them.
Also use the current API response instead of the old one and correct some
old reference link.
blueprint complete-todo-in-api-concept-doc
Change-Id: I90b39959a6a13f37ec0c03cf6f86943eba6c47d1
This patch adds generic description for microversions. We will write
more use-cases in later patches.
blueprint complete-todo-in-api-concept-doc
Change-Id: I600ad4186a38eaffbec38bb15b2de0146c076abf
There are variety like "admin" or "administrator" on api-guide,
so this patch makes these words consistent for the readability.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: Id0a9444e5d48f62d6d02114f8668761647c2dae0
There still have some important concept in the docs, this patch adds
more to it.
blueprint complete-todo-in-api-concept-doc
Change-Id: I231f298d2c7ffa0736028db27fe54691ac4bd201
Most parts contain "ReSTful HTTP service" instead of "ReSTful web
service". So this patch changes "ReSTful web service" for the word
consistency.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: I642ae649adad8f886bdb6bce979a1dd7d2430a80
This patch corrects the fault message format, and use an example which
existed in the real world.
blueprint complete-todo-in-api-concept-doc
Change-Id: I76706cca5a9fdcfa6c3e2c9d08aa8f94fb9471d8
This patch updates the API concept guide about services.
blueprint complete-todo-in-api-concept-doc
Change-Id: I9196cb6b700687d2a42d4bf32ecb02a7300a9475
There are two parts talk about error handling in nova api.
One is under general-info, and another one is under separated section
fault. This patch remove the empty one.
blueprint complete-todo-in-api-concept-doc
Change-Id: I4b9e79bf96fc5e8aa5a143f38a25e258a8be82f4
There isn't 'fault' field in the response of image API. So remove
image stuff from the faults section.
blueprint complete-todo-in-api-concept-doc
Change-Id: I79d2b4a3dc492b8410b649756057c2d824f19989
In the introduction to the guide, note that there is a single API for
both end users and operators.
blueprint complete-todo-in-api-concept-doc
Change-Id: I726d1f230c0090ca8890195f56167e19a18e4665
* There isn't any support specify a host for cold migration API.
Remove the words about cold migration can do explicitly decision.
* Use some cloud operators instead of some users for resource
optimization case.
blueprint complete-todo-in-api-concept-doc
Change-Id: Iea266d61551666edfa4f6bb3d4f3d3f03c8b57f4
The api guide server concepts section uses the terms
instance and server interchangably and inconsistently.
This patch fixes that.
blueprint complete-todo-in-api-concept-doc
Change-Id: Iafa57c90c010f4bfba493b917ee4f82986739769
The current navigation bar includes a strange gap in it due to how the
toctrees are currently arranged in the document. This moves them into a
single list.
blueprint complete-todo-in-api-concept-doc
Change-Id: I3c6c68bafb589887e32a990e0cccf1bff9e68518
I have moved the resize and shelved operations after the discussion of
the cloud operator initiated migrate. This adds better context around
the comments that say resize and shelved are unlikely to be initiated by
and operator.
blueprint complete-todo-in-api-concept-doc
Change-Id: I7fd72b5fd2d4e724d4465fe002f7951e60dcbe3d
This adds in some titles, to replace the bold text that simulated
heading. It also changes the text into use cases rather than actions.
It includes a some additions around:
* resource optimization use cases for live-migration
* data loss during evacuate
* downtime during resize
* clearer description of why a user would call shelve
This does not complete this doc, but should help improve the readability.
blueprint complete-todo-in-api-concept-doc
Change-Id: Ib2cf479c14a1c2f3b119ba7f549a00c9bd541cf9
follow up patch for https://review.openstack.org/#/c/236947/
some comments made there and it's valuable, change the doc
according to the comments.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: Icc26a518d7e568041a938b76a6fe0fe580182ce3
Migration (including cold and live migration), resize and shelve
are three concepts at the API level that support three distinct
sets of use cases. These all involve movement of servers and
so provide opportunity for operational efficiency.
This patch adds a section to the server concepts that outlines
the purpose behind the actions and the operational efficiencies
that can be gained by them.
blueprint complete-todo-in-api-concept-doc
Change-Id: I6b9c6c179c1bdd9400abae7deb1918b370ddaefd
some server status are missing, add them to the list.
also, remove a duplicate server status for creating server.
blueprint complete-todo-in-api-concept-doc
Change-Id: Ib25b57b5044df8dc8061a6de9978d9ee840885dd
Jenkins