72 Commits

Author SHA1 Message Date
songwenping
8e5515c1fa Trival change: spell error of Shelve
Change-Id: I3ff89b84f6c8caab952dcc0b85836744565f1372
2021-04-07 02:10:19 +00:00
Victor Coutellier
4018d6fb71 Non-Admin user can filter their instances by more filters
Microversion bump to allow non-admin user to use more filters key
when listing instances.

In order to stay coherent, all existing instance filters who are
related to a field readable by default to non admin users when showing
instance details, should be allowed by default without policy
modification.

Implements: blueprint non-admin-filter-instance-by-az

Change-Id: Ia66d3a1ceb74ed521cf44922929b2a502f3ee935
2020-03-15 17:35:49 +01:00
Zuul
67d9b5114e Merge "Fix typos in nova doc" 2020-01-10 23:27:11 +00:00
zhufl
ea172ef85f Fix typos in nova doc
This is to fix the following typos:
  regadless
  users's
  possile
  caculated

Change-Id: If47adefa59f01b7f2ebcee5b7e07e0260df113e4
2020-01-09 15:49:49 +08:00
Stephen Finucane
02eb9cffe6 Remove 'nova-xvpvncproxy'
This legacy service is no longer used and was deprecated during the
Stein cycle [1]. It's time to say adios and remove them in their
entirety. This is pretty straightforward, with the sole exception of
schema for the 'remote-consoles' API, which has to continue supporting
requests for type 'xvpvnc' even if we can't fulfil those requests now.

[1] https://review.opendev.org/#/c/610076/

Part of blueprint remove-xvpvncproxy

Depends-On: https://review.opendev.org/695853
Change-Id: I2f7f2379d0cd54e4d0a91008ddb44858cfc5a4cf
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-12-23 14:20:28 +00:00
Matt Riedemann
e49433d2cd api-guide: fix the file injection considerations drift
When these docs were initially imported [1] the "Considerations"
section was after "Server personality" but [2] refactored the
latter and forgot about the former. This fixes that so
"Considerations" is now just nested into the "Server personality"
section.

[1] I6d5ba6b96772e0f17fc7484312222110ec103bbf
[2] Ibbffdb00d1529a386f338da4776eb614891731c8

Change-Id: Ife6acefd42b9b2f5910fe8f0b1b001eeec80ff06
2019-11-22 16:41:18 -05:00
Matt Riedemann
15011fc13b api-guide: flesh out BUILD and ACTIVE server create transitions
Change-Id: I14df54db9864e6df8a8bbc0fcc50e2cbb0ba6793
2019-11-22 16:36:10 -05:00
Matt Riedemann
2d91a8463f docs: update SUSPENDED server status wrt supported drivers
Two things here:

1. The API guide was missing the hyper-v driver which supports
   the suspend operation. Rather than hard-code a list of supported
   drivers in the doc, this change just links to the entry in the
   feature support matrix.

2. The supported hypervisors mention in the API reference is removed
   because the end user using the API should not need to know or care
   what backend hypervisor on which their server is running. They can
   either suspend or not, but we don't need to mention the supporting
   drivers for that in the API reference.

Change-Id: Ib76779a8e34b2c68b0f4af190f71576180360d0f
Related-Bug: #1815403
2019-11-14 10:25:06 -05:00
Zuul
bd0eab8ff5 Merge ""SUSPENDED" description changed in server_concepts guide and API REF" 2019-11-14 03:08:11 +00:00
Sharat Sharma
3badb674f6 "SUSPENDED" description changed in server_concepts guide and API REF
The description of "SUSPENDED" server status was misguiding. Rewording
it to make it more accurate.

Change-Id: Ie93b3b38c2000f7e9caa3ca89dea4ec04ed15067
Closes-Bug: #1815403
2019-11-13 17:11:27 +00:00
Andreas Jaeger
dbe6321537 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that Neutron publishes to api-ref/network, not networking anymore.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
2019-07-22 19:17:28 +02:00
Zuul
68b2ec6fda Merge "docs: Rework all things metadata'y" 2019-06-23 09:13:08 +00:00
Artom Lifshitz
9e8ba1f3b6 api-guide: better explain scheduler hints.
This patch explains what scheduler hints are, gives an example
request, then links to the api-ref for details.

Co-Authored-By: Artom Lifshitz <alifshit@redhat.com>

Change-Id: I1c55b9a17e9d9f57d9ec1383680cccb6ae7fcfaf
2019-06-21 09:35:31 -04:00
Stephen Finucane
92a432fde7 docs: Rework all things metadata'y
Turns out we've a *lot* of disparate metadata systems. Attempt to both
link them somewhat through extensive cross-referencing and extract out
deployment-specific stuff from user-facing docs. Lots of changes here,
but in summary:

- Split out admin-focused content from the metadata API, config drive,
  user data and vendordata docs.

- Merge the config drive, metadata service, vendordata and user-data
  user docs, which are mostly talking about the same thing and are
  fairly barren without the deployment components

- Make use of various oslo.config and Sphinx roles

Side note: I miss when we have tech writers to do this stuff for us :(

Change-Id: I4fb2b628bd93358a752e2397ae353221758e2984
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-20 18:22:34 +01:00
Qiao, Liyong
0919ea6390 Api-guide: Add Block Device Mapping
Added some descriptions and example about block device mapping in
api-guide, this will help the API user to better understand how to
provide block device mapping information in server request body.

Change-Id: I5a85d7f190f7cda160e1e13805d356a2d4303bf0
2019-06-13 11:58:20 -04:00
Surya Seetharaman
fccdaabd64 [Trivial doc change] Admin can overwrite the locked_reason of an owner
Change-Id: Id60d7a54e7bce49b938f9f10a0691b05613cbee0
2019-05-14 19:04:08 +00:00
Surya Seetharaman
c541ace518 Microversion 2.73: Support adding the reason behind a server lock
This patch adds a new parameter ``locked_reason`` to
``POST /servers/{server_id}/action`` request where the
action is lock. It enables the user to specify a reason when locking
a server.

The locked_reason will be exposed through ``GET servers/{server_id}``,
``GET /servers/detail``, ``POST /servers/{server_id}/action``  where
the action is rebuild and ``PUT servers/{server_id}`` requests' responses.

The InstanceActionNotification will emit the locked_reason
along with the other instance details. This patch hence changes the
payload object to include the "locked_reason" field.

Note that "locked" will be allowed as a valid filtering/sorting parameter
for ``GET /servers/detail`` and ``GET /servers`` from this new microversion.

Implements blueprint add-locked-reason

Change-Id: I46edd595e7417c584106487123774a73c6dbe65e
2019-05-11 21:48:27 +00:00
Surya Seetharaman
16f2571e07 [Docs] Change the server query parameter display into a list.
The server query parameters that are allowed for users are displayed
in a single paragraph which is difficult to parse and some of the
parameters are missing the microversions they are available from.
This problem exists in the server_concepts api-guide documentation
while its already in the list form in the servers api-reference
documentation. This patch basically copies the list over from the
api-guide.

Change-Id: I27c3d1882ab904933129bd3414ccded8c3c56b1e
2019-05-07 17:15:30 +02:00
Takashi NATSUME
5fdcb2ca49 Remove wrong description for auto resize confirm
Remove wrong description for auto resize confirm
in the API guide.
Move a description of a configuration option
'resize_confirm_window' from the API guide
to the admin configuration guide.
Add a description of automatic resize confirm
in the user guide.

Change-Id: If739877422d5743e221c57be53ed877475db0647
Closes-Bug: #1816859
2019-03-03 20:03:09 +00:00
Surya Seetharaman
833af5c9bf API microversion 2.69: Handles Down Cells Documentation
This patch adds the documentation around the work regarding
handling down cells that was introduced in v2.69.

Related to blueprint handling-down-cell

Change-Id: I78ed924a802307a992ff90e61ae7ff07c2cc39d1
2019-02-20 10:10:50 -08:00
Takashi NATSUME
442c7c68c2 api-ref: Body verification for the lock action
This patch adds more explanations for the lock action
in the Compute API reference and the Compute API guide.

Change-Id: Iae4a42351d11d5caade9a1a299b06fed862a7da4
Partial-Bug: #1793034
2019-01-17 04:05:50 +00:00
Takashi NATSUME
54d3745101 Fix server query examples
The 'locked' query parameter is not supported
in the "List Servers Detailed" API.
So replace examples using the 'locked' query parameter
with examples using another query parameters.

Change-Id: Ibcea6147dd6716ad544e7ac5fa0df17f8c397a28
Closes-Bug: #1801904
2018-11-19 23:22:39 +00:00
Takashi NATSUME
ddf7c6e370 Improve formats of the Compute API guide
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.

Improve some format in the guide.
e.g. Fix unnecessary bold characters.

Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
2018-11-07 04:01:40 +00:00
zhangbailin
614ecfc435 Rename "polling_changes-since_parameter.rst"
In order to record the update history, use "git mv" to rename the
api-guide doc.

Depends-On: https://review.openstack.org/599276/
Part of bp support-to-query-nova-resources-filter-by-changes-before
Change-Id: I594dcead5edc222cb040cf11675fc76358e93ef8
2018-09-23 06:42:34 -04:00
zhangbailin
28c1075b59 Resource retrieving: add changes-before filter
This adds the changes-before filter to the servers,
os-instance-actions and os-migrations APIs for
filtering resources which were last updated before
or equal to the given time. The changes-before filter,
like the changes-since filter, will return deleted
server resources.

Part of bp support-to-query-nova-resources-filter-by-changes-before
Change-Id: If91c179e3823c8b0da744a9363906b0f7b05c326
2018-09-19 09:56:56 -04:00
Matt Riedemann
579e0cfd57 Document differences and similaries between extra specs and hints
Scheduler hints are not really documented very well at all except
for being mentioned per scheduler filter in the admin configuration
guide, nor are they documented within relation to flavor extra
specs which are both used for impacting scheduling decisions and
are choices that a deployer has to make based on how they configure
their cloud.

This change adds a document about scheduler hints and how they are
similar to and different from flavor extra specs, including end
user discoverability and interoperability, and thoughts on which
should be used if writing a custom scheduler filter.

The TODO in the API guide is also resolved by linking to this
document.

Change-Id: Ib1f35baacf59efafb9e4bccfcc4f0025d99ad5b2
2018-08-29 19:09:11 -04:00
Stephen Finucane
dd1a416bc9 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00
jichen
92bce2558f Add config drive link to api-guide
link api-guide to doc of nova.
Removed the TODO.

Change-Id: Ib7b9453535b43e5c5cec6ee252a5790fc278f0c0
2018-04-16 11:36:27 +08:00
jichen
68c32a552b Update link of metadata
commit 43f91a87cb4f14078d39d8ce6e8308f4b37eac74
enhanced the metadata doc, so we can adjust other links to
this new doc.

Change-Id: I35803472666e39f3e7d947e65760d97c0a7959bb
2018-04-13 11:15:39 +08:00
gaofei
a9769a8488 Replace curly quotes with straight quotes
Sphinx's "smart quotes" feature will ensure these are replaced during
generation of docs.

Change-Id: I96412d86ac67c0dbaa0edb88815daa795e3cb1d8
2018-01-23 09:25:05 +00:00
Zuul
50cb2562ba Merge "Update description of Rebuild in server_concepts.rst" 2017-12-01 01:44:29 +00:00
lianghao
0565cf2c08 Update description of Rebuild in server_concepts.rst
Change-Id: I3c6e04886ef478b8d4a52e9b3d073c5fa7d78094
2017-11-30 20:32:29 +00:00
Zuul
b0b301506d Merge "Api guide:add Server Consoles" 2017-11-26 15:23:14 +00:00
Zuul
6457bb3df8 Merge "Update server status api guide" 2017-11-24 17:00:52 +00:00
Zuul
7678139e38 Merge "Update Metadata api section of api guide" 2017-11-24 17:00:41 +00:00
He Jie Xu
201b150865 Update server query section in the API concept doc
Update and cleanup server query section in the API concept doc.

Change-Id: Id0e2cb31bd6234be169eac66bc97fd1635ef6704
2017-11-24 09:46:03 +08:00
leizhang
409b511dbb Update server status api guide
Add description for vm_state and task_state in server status section.

Change-Id: I5791245c0faee052b6ad680fbe712c2dd16db063
2017-11-23 08:52:57 +08:00
sunjia
ace3244536 Api guide:add Server Consoles
Change-Id: I9b720d86533edf69ffe1b86d368611729579b1fd
2017-11-23 07:29:19 +08:00
leizhang
5a03a9127d Update Metadata api section of api guide
Address todo in Metadata api section of api guide

Change-Id: Ieb68614a41918928dde86d2d866c593e8cc94cc4
2017-11-23 03:54:16 +08:00
Matt Riedemann
d57b4db03b Update "SHUTOFF" description in API guide
Two things are updated here:

1. The SHUTOFF status from the API is for any stopped server,
   regardless of whether or not it was stopped via the REST API
   or the sync_instance_power_state periodic task in the compute.

2. Remove the mention of the "shutdown_terminate" flag since that
   was only ever implemented in the legacy v2 API for EC2
   compatibility and it wouldn't actually work now with the v2.1
   server create schema anyway.

Change-Id: I97071be164d15298fa2a5a7374a8ba8235d188e4
Related-Bug: #1722403
2017-10-11 16:33:47 -04:00
Matt Riedemann
2f80a62005 docs: cleanup wording for 'SOFT_DELETED' in api-guide
The previous description of this status value was hard to
process. This cleans it up a bit.

Change-Id: I952bc712adf0dd7932da7eed460c10759ff3f9f2
2016-11-28 11:51:00 -05:00
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