240 Commits

Author SHA1 Message Date
He Jie Xu
7b0b8c3754 docs: update old stuff in version section
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
2015-12-08 19:44:02 +08:00
He Jie Xu
50aa74f91d docs: add microversions description in the concept doc
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
2015-12-08 14:17:36 +08:00
Ken'ichi Ohmichi
da3001bc80 Make admin consistent
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
2015-12-08 05:36:11 +00:00
He Jie Xu
d5fa24bb85 Add more concepts for servers
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
2015-12-08 11:05:07 +08:00
Ken'ichi Ohmichi
4ce28e5c2b Make "ReSTful service" consistent
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
2015-12-08 01:44:13 +00:00
Jenkins
f2f6017f7b Merge "Add user data into general concept" 2015-12-04 09:07:34 +00:00
Jenkins
c0be3f0479 Merge "Remove description about image from faults section" 2015-12-04 08:58:02 +00:00
Jenkins
dce797b517 Merge "docs: using the correct format and real world example for fault message" 2015-12-03 23:04:10 +00:00
Jenkins
586b08ea4a Merge "doc: add server status to concept.rst" 2015-12-03 17:05:48 +00:00
Jenkins
9e4e9ce9f2 Merge "Docs: update the concept guide for Host topics" 2015-12-03 16:55:09 +00:00
He Jie Xu
10559e91e1 docs: using the correct format and real world example for fault message
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
2015-12-03 16:07:28 +00:00
Jenkins
4a9133d464 Merge "docs: remove duplicated section about error handling" 2015-12-03 15:29:15 +00:00
Jenkins
71f1c6ddf9 Merge "docs: update services description for concept guide" 2015-12-03 15:16:21 +00:00
He Jie Xu
78db34c0b5 docs: update services description for concept guide
This patch updates the API concept guide about services.

blueprint complete-todo-in-api-concept-doc

Change-Id: I9196cb6b700687d2a42d4bf32ecb02a7300a9475
2015-12-03 13:17:00 +08:00
He Jie Xu
4a2deac943 docs: remove duplicated section about error handling
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
2015-12-03 05:07:50 +00:00
EdLeafe
86a4c8e143 Docs: update the concept guide for Host topics
Added text to the 'Hosts' and 'Host Actions' sections.

Change-Id: Ie139810b97ab0a9bb96c928ffb794353c6f0c0ae
2015-12-02 19:43:26 +00:00
He Jie Xu
2ee6ddf686 Remove description about image from faults section
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
2015-12-02 18:22:35 +08:00
John Garbutt
dbf5dfa4dc api-guide: add note about users
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
2015-12-02 10:04:39 +00:00
Jenkins
bfa6d51c1c Merge "api-guide: fix up navigation bar" 2015-12-02 02:37:08 +00:00
Jenkins
0f44add33f Merge "Correct some nits for moving servers in concept doc" 2015-11-30 10:15:42 +00:00
Jenkins
ec45381882 Merge "Make server concept guide use 'server' consistently" 2015-11-30 10:15:10 +00:00
Jenkins
1427b9f5b6 Merge "docs: reorder move servers text" 2015-11-30 10:05:35 +00:00
Jenkins
7bc2171869 Merge "docs: add clarifications to move servers" 2015-11-26 07:47:17 +00:00
He Jie Xu
29847bb26c Correct some nits for moving servers in concept doc
* 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
2015-11-26 15:07:53 +08:00
Paul Murray
d93cedb8af Make server concept guide use 'server' consistently
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
2015-11-25 13:04:55 +00:00
John Garbutt
fa602a3ff5 api-guide: fix up navigation bar
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
2015-11-25 12:56:29 +00:00
John Garbutt
9dcb598cd0 docs: reorder move servers text
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
2015-11-25 12:22:37 +00:00
John Garbutt
186d45cb4a docs: add clarifications to move servers
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
2015-11-25 12:19:34 +00:00
jichenjc
07c3d28263 Change some wording on server_concepts.rst
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
2015-11-25 15:59:03 +08:00
Jenkins
8970fc9e4f Merge "docs: describe migration and other movement concepts" 2015-11-24 18:09:39 +00:00
Jenkins
f8e1be2217 Merge "docs: update the concept guide shelve actions" 2015-11-24 16:48:20 +00:00
Paul Murray
192e6b1d03 docs: describe migration and other movement concepts
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
2015-11-24 11:55:25 +00:00
jichenjc
e4543e952a doc: add server status to concept.rst
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
2015-11-24 01:26:20 +08:00
Paul Murray
4a3be830af docs: update the concept guide shelve actions
The shelve_offload action is missing from the concept guide.
This updates the description of the shelve actions to include
shelve_offload. The text is slightly changed to keep the flow.

blueprint complete-todo-in-api-concept-doc

Change-Id: I15d574adfef5b604b5bf0fdfb254d703ac13e1bb
2015-11-23 17:12:48 +00:00
jichenjc
9485971ac3 Add user data into general concept
This patch add brief introduction of user data, how
nova offer it to end user and server consume it.

blueprint complete-todo-in-api-concept-doc

Change-Id: I3514247698bc4eeae358ae2a1ee9ad4e77d764fc
2015-11-22 13:16:11 +08:00
ChangBo Guo(gcb)
c9773683ad Fix a typo in api-guide doc
Change-Id: Ic0d3bedda46312f41359a212b02e5fc01a71d960
2015-11-21 14:08:25 +08:00
Jenkins
f6a672f480 Merge "docs: update the API faults concept guide" 2015-11-19 14:55:36 +00:00
jichenjc
aad2d1aaa0 Add more 'actions' for server concepts doc
commit cf44f0ab7d89784f5ac231b20ec99e3b540b7aa3 add server
concepts for the servers, some TODOs for other actions,
this patchs add the items.
Some comments are copied from support matrix doc
http://docs.openstack.org/developer/nova/support-matrix.html
which mainly talked about virt layer support while this doc more
talk about server concepts.

Partially implements blueprint complete-todo-in-api-concept-doc

Change-Id: I08c97c78b334bd17b37492ac60a7489ac6fe07de
2015-11-18 06:51:52 -05:00
John Garbutt
c9f0adc12a docs: update the API faults concept guide
This updates the API concept guide to talk about request-ids
and the Server Actions API, while keeping the existing content
on sync and async errors.

blueprint complete-todo-in-api-concept-doc

Change-Id: Icbc4a3a3559552f7d210838536897e411a9d4ce4
2015-11-16 16:39:41 +00:00
Anne Gentle
17961c41a3 Rearranges to create new Compute API Guide
Uses openstackdocstheme to match other content

Has a dependent change in project-config also so that
file will build to developer.openstack.org/compute
at https://review.openstack.org/#/c/231000/

Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
2015-11-12 10:47:23 +00:00