95 Commits

Author SHA1 Message Date
Hironori Shiina
230958c002 Documentation fix regarding triggering crash dump
How to trigger crash dump depends on hypervisors. NMI is not the only way to
implement the feature. This patch modifies description regarding this feature.

Change-Id: I77d10551650776c06ee4b413f1b027abf6620e83
2016-03-04 13:04:44 +09:00
Jenkins
35033197c2 Merge "doc: all_tenants query option incorrectly identified as non-admin" 2016-02-26 13:05:16 +00:00
Waldemar Znoinski
fdd8f0f91e Fix API Guide doc
* typos
* reduntant words
* reworded sentences for clarity

Closes-bug: #1545748

Change-Id: I0700d04de38b34cf13988490873b8c34dad1005b
2016-02-23 11:00:18 +00:00
Jenkins
6ad6206e28 Merge "Fix some word spellings in messages" 2016-02-22 19:01:10 +00:00
Eoghan Glynn
f7c18c4393 doc: all_tenants query option incorrectly identified as non-admin
The all_tenants option was incorrectly described as being available
to general users.

Change-Id: I739da63b3d5460ff1ef8dcafd21d58829a3a4852
2016-02-06 14:03:25 +00:00
Jenkins
11dfd9def3 Merge "Trivial: Remove a duplicated word" 2016-02-03 09:15:58 +00:00
Jenkins
22810c4dd7 Merge "Add description for server query" 2016-02-03 07:03:30 +00:00
venkatamahesh
f86daf0607 Fix some word spellings in messages
Change-Id: I40e3c0f3b99ae853f84609c5334e6d230dfff867
2016-02-03 12:07:53 +05:30
Jenkins
22e0e06ec1 Merge "doc: remove detail about extensions" 2016-02-03 03:34:06 +00:00
xiexs
959b51f3d4 Trivial: Remove a duplicated word
s/there there is/there is/

Change-Id: I3c352b97ca9e191834c933bfd31261fefda12d59
2016-02-02 10:23:14 -05:00
Jenkins
befefa43b5 Merge "Add description for trigger crash dump" 2016-02-02 15:03:47 +00:00
He Jie Xu
d04f7f7e12 doc: remove detail about extensions
As extensions are already deprecated in Nova, this patch removes
all of the details about extensions, adds a note about the deprecation
of extensions, and points to documentation about microversions for
discovering API changes.

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

Co-Author: Ed Leafe <ed@leafe.com>

Change-Id: I56acfeac5b8b3312547c06d79962a79991c5c8f3
2016-02-02 12:03:49 +00:00
xiexs
2051e3b361 Add description for trigger crash dump
Add description for server trigger crash dump operation
into api-guide.

Change-Id: I20492dbf9eab4f7fcab0864bb250b20f98b762e4
blueprint complete-todo-in-api-concept-doc
2016-02-02 01:41:54 -05:00
Jenkins
ae8546c542 Merge "remove docs about format extensions" 2016-01-28 17:47:59 +00:00
Jenkins
2b1d5a9b36 Merge "doc: add client interactive guideline for microversions" 2016-01-25 02:36:48 +00:00
Jenkins
aa9db1ccef Merge "doc: add version discovery guideline in api concept doc" 2016-01-25 02:36:09 +00:00
Jenkins
1b3fa9d316 Merge "doc: completes microversion use-cases in api concept doc" 2016-01-25 02:35:26 +00:00
Jenkins
d8b47767ac Merge "doc: minor corrections to the API version docco" 2016-01-22 13:13:38 +00:00
jichenjc
040577c0cf Add description for server query
Add descriptions for server query options and add some
samples for the query options.

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

Change-Id: Id23a19ecc30f1837f4755ec898ef0389dcf23a8f
2016-01-22 00:14:46 +08:00
Sean Dague
e9646a4419 remove docs about format extensions
The format extensions concept (adding .json / .xml) is no longer
really a thing. The router supports it, but we only have json
responses, so there is no reason to advertise it.

Change-Id: I07ba13a98ce55c215c6b676b5ff41d7d60babfde
2016-01-21 10:43:43 -05:00
He Jie Xu
d87f6b4537 doc: add client interactive guideline for microversions
This patch adds basic interactive guideline.

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

Change-Id: I3c828e34c43fa681328f71694940f05c87d28e06
2016-01-21 11:01:22 +08:00
He Jie Xu
2433bc5454 doc: add version discovery guideline in api concept doc
This patch adds basic guideline how to discover microversion with
version API.

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

Change-Id: I55b50e8300c67b9ec94587a2bdccac55a9c115a0
2016-01-21 11:01:22 +08:00
He Jie Xu
670ae42359 doc: completes microversion use-cases in api concept doc
This patch adds last few use-cases for microversion.

blueprint complete-todo-in-api-concept-doc
Change-Id: Ib472c91289fc153e1462d5137eb1b5caebca9a2f
2016-01-21 11:00:59 +08: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