Commit Graph

73 Commits

Author SHA1 Message Date
Jenkins d8b47767ac Merge "doc: minor corrections to the API version docco" 2016-01-22 13:13:38 +00:00
Jenkins 0b7904eb64 Merge "api-guide: add a doc on users" 2016-01-12 15:02:03 +00:00
Eoghan Glynn 73e979d419 doc: minor corrections to the API version docco
Miscellaneous corrections for grammar and clarity.

Change-Id: Ibec4d907a074cf37b2a007011e1fd82c90633b39
2016-01-07 11:39:13 +00:00
Harshada Mangesh Kakad c40464514d Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: Iea9c0501f46c57d809217912fb0f40eb2bc4f111
Closes-Bug: #1529836
2016-01-06 09:45:21 -08:00
Jenkins c8b1b2178d Merge "Fix typo, ReST -> REST" 2016-01-05 21:52:14 +00:00
John Garbutt e7106c3e75 api-guide: add a doc on users
To help add color to the API doc, we use a common set of persona when
talking about the use cases behind each API.

This is really just a quick sketch that adds TODOs for others to follow
up on, in order to complete the guide.

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

Change-Id: I71a07caa27f1b17d3256a5439e867c40fc9d0abd
2016-01-05 13:46:29 +00:00
Felix Li f78030a8ad Fix typo, ReST -> REST
Common usage is REST, and most in project are written as REST.
Change ReST to REST to comply with it.

Change-Id: I2c87f4c811f7dd64a3f5807a45eba2a82373da36
2016-01-04 16:13:32 -05:00
Jenkins 013bd2ab88 Merge "Add hypervisor, aggregates, migration description" 2016-01-04 14:00:07 +00:00
Jenkins 2c050707af Merge "simplify the request / response format document" 2015-12-21 10:24:33 +00:00
Jenkins 88cbd39a06 Merge "Remove incorrect comments about file injection" 2015-12-21 10:23:44 +00:00
Jenkins ad74cce240 Merge "docs: add concept guide for certificate" 2015-12-21 09:03:08 +00:00
Jenkins 6e18eeb7a5 Merge "Remove XML description from extension concept" 2015-12-18 17:25:24 +00:00
Jenkins c16dea5843 Merge "Remove a restriction on injection files" 2015-12-18 16:07:15 +00:00
Ghanshyam 6f06c1d653 docs: add concept guide for certificate
This patch adds the concept guide for certificate.

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

Change-Id: If44e5f4633ee47d235e8254904d950e7d81d39c1
2015-12-16 17:28:43 +09:00
Jenkins d460d58a0d Merge "Change some wording on server_concepts.rst" 2015-12-15 06:14:37 +00:00
Jenkins ededf5b4de Merge "docs: update old stuff in version section" 2015-12-15 01:42:13 +00:00
Jenkins 62c07ef41c Merge "Add separated section for configure guest os" 2015-12-15 01:40:38 +00:00
Jenkins bb594e8165 Merge "Add separated section for extra specs and image properties" 2015-12-15 01:40:05 +00:00
Sean Dague 44a36ba7af simplify the request / response format document
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
2015-12-14 12:35:14 -05:00
Ken'ichi Ohmichi 32ce20c41c Remove XML description from extension concept
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
2015-12-14 11:14:50 -05:00
jichenjc 326de7607a Remove incorrect comments about file injection
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
2015-12-12 09:45:06 +08:00
jichenjc 761437ec68 Remove a restriction on injection files
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
2015-12-12 09:44:19 +08:00
jichenjc 534e34fd60 Add hypervisor, aggregates, migration description
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
2015-12-11 22:16:34 +08:00
Andreas Jaeger a54834df23 Report compute-api bugs against nova
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
2015-12-11 06:58:33 +01:00
Jenkins b5890b3c36 Merge "Edit the text to be more native-English sounding" 2015-12-09 07:52:47 +00:00
He Jie Xu 912384e650 Add separated section for configure guest os
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
2015-12-09 14:01:04 +08:00
He Jie Xu faac6a59d2 Add separated section for extra specs and image properties
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
2015-12-09 13:59:03 +08:00
Jenkins ca40e31490 Merge "Fix the endpoint of /v2 on concept doc" 2015-12-09 04:05:41 +00:00
Jenkins da17a368e6 Merge "Add more concepts for servers" 2015-12-08 18:12:29 +00:00
Jenkins fc105fcd87 Merge "Make "ReSTful service" consistent" 2015-12-08 18:11:53 +00:00
Jenkins 92a4197545 Merge "docs: add microversions description in the concept doc" 2015-12-08 18:10:59 +00:00
EdLeafe 231c9a1589 Edit the text to be more native-English sounding
No substantial changes; just wanted to make the text sound more like
native English.

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

Change-Id: I9ff48113bf709f63e3654a5851aa8d6853b519b5
2015-12-08 14:58:00 +00:00
Ken'ichi Ohmichi 1c6076a2fb Fix the endpoint of /v2 on concept doc
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
2015-12-08 12:50:54 +00:00
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