31 Commits

Author SHA1 Message Date
Atsushi SAKAI
340b7e9404 [doc] fix 5 typos
tweek        => tweak
adminstrator => administrator
mulitple     => multiple
definied     => defined (2-locations)

Change-Id: Ibe2c04e1b225515f7a6c83b5a4a8d91e8385140a
2016-04-28 20:40:18 +09:00
Ken'ichi Ohmichi
6ee7d4413a Fix JSON format of server_concepts
server_concepts.rst contains some invalid JSON formats as samples.
This patch fixes them and improves the readability by adding some
spaces.

Change-Id: Ib51f9e1351fca51c15ffdcb98f42311b999f22f5
2016-03-21 10:36:50 -07:00
Andreas Jaeger
f25648a963 Error on API Guide warnings
Error on warnings in building the API guide and fix any problem
encountered:
* tox.ini: Enable tread warnings as errors
* index.rst: Add unreferenced file extra_specs_and_properties as
  hidden file so that it does not show up in index. It is still
  built and will be referenced from other files.
* general_info.rst: Remove reference to non-existing file
* server_concept: Add missing empty line after code directives

Also fix a typo and remove extra EOL whitespace.

Change-Id: Ie766f8d2f7d82b7b5b02541b342f9829ca4550a0
2016-03-17 07:57:23 +01:00
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
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
xiexs
959b51f3d4 Trivial: Remove a duplicated word
s/there there is/there is/

Change-Id: I3c352b97ca9e191834c933bfd31261fefda12d59
2016-02-02 10:23:14 -05: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
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
Jenkins
88cbd39a06 Merge "Remove incorrect comments about file injection" 2015-12-21 10:23:44 +00:00
Jenkins
c16dea5843 Merge "Remove a restriction on injection files" 2015-12-18 16:07:15 +00:00
Jenkins
d460d58a0d Merge "Change some wording on server_concepts.rst" 2015-12-15 06:14:37 +00: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
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
Jenkins
da17a368e6 Merge "Add more concepts for servers" 2015-12-08 18:12:29 +00: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
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
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
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
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
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
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
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
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