Commit Graph

169 Commits

Author SHA1 Message Date
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
Zuul
6a74828621 Merge "Document differences and similaries between extra specs and hints" 2018-09-10 20:18:41 +00:00
Matt Riedemann
de27a387b0 Fix formatting in changes-since guide
This fixes the weird formatting in the changes-since
guide along with splitting up the giant wall of text
so this is easier to consume.

Change-Id: Ia15d3b5e3e1e8279d9109ca9c54f213c3e7838bb
2018-09-07 14:29:57 -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
Sean Dague
8835198b8d Update api-guide and api-ref to be clear about forced-down
Closes-Bug: #1691871
Related-Bug: #1784826

Change-Id: Ifc6f1549d88a1b7d9f6e25c962c8a15dd8e180fb
2018-08-17 01:41:31 +00:00
zhufl
fbc86f8844 Fix none-ascii char in doc
There exist some none-ascii chars in doc, which may cause trouble
in displaying.

Change-Id: I1ebf83fb4e8cc853fd7f3065ecf420a064c9983f
2018-08-07 00:13:00 +00:00
Zuul
c52cd8dac4 Merge "Fix the incorrect description and sample" 2018-08-01 14:43:09 +00:00
chenxing
22ab1b62b3 Fix the incorrect description and sample
This patch fixes the following:
 * The description says, "Here, a subset of metadata items
   are presented within the image." This is a server sample,
   not an image.

 * The sample itself has the wrong id in the "self" link and
   there are no metadata_links with a server object (probably
   a carry over from an image docs sample).

Change-Id: Idb1e5243d6d072e020e1532bec603e5cd219702e
Closes-Bug: #1737854
2018-07-18 06:54:29 +00:00
jichen
8d68281ddd Enhance api-guide general info some updates
include:
1) add additional links 2
2) remove deprecated info about volume APIs
3) add a note about host API deprecation
4) remove ec2 service in doc

Change-Id: I3b5be18edbeff9c404591015f769e1a6040ed57e
2018-06-05 16:54:18 +08:00
Zuul
b36d317524 Merge "doc: cleanup API guide about instance faults" 2018-05-30 21:52:23 +00:00
Zuul
d741f624c8 Merge "doc: Start using openstackdoctheme's extlink extension" 2018-05-30 15:21:12 +00:00
Zuul
d5049878ca Merge "Deprecate the nova-consoleauth service" 2018-05-08 04:21:43 +00:00
melanie witt
e91dad3ee9 Deprecate the nova-consoleauth service
Part of blueprint convert-consoles-to-objects

Change-Id: I9bfa89d2d8fe2b5803b4e1478377e13dc3231b1c
2018-05-03 10:02:29 -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
inspurericzhang
eb4be18045 Replace Chinese punctuation with English punctuation
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I6f95feebd46353b3234e189e8d41a0c11835eb9f
2018-05-02 14:59:09 +08: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
Matt Riedemann
88f86e24e1 doc: cleanup API guide about instance faults
The compute API guide section on instance faults
is updated to point out that server details contain
fault information for servers in ERROR or DELETED status
along with a simple non-admin scenario example.

Change-Id: Idc725a594b67b5f6e45c6f161f6e92c0601761a8
Closes-Bug: #1762842
2018-04-13 09:51:38 -04:00
jichen
68c32a552b Update link of metadata
commit 43f91a87cb
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
Zuul
2887e4366c Merge "Update links in documents" 2018-02-08 01:29:29 +00: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
zhangbailin
110b499b6a Update links in documents
Due to the migration of the OpenStack document library, some outdated
links were found during use, using https instead of http and pointing
to the right place.

Change-Id: I1e37e15643b4ff7a7b22b2c7c39eba76d0cbdb39
2018-01-12 17:05:11 +08:00
chenxing
fbba1d17a4 Fix the bug report link of API Guide
Currently, it redirects back to the same page.

Change-Id: Ia855ad2cfa1fdc42bffac07812799b032a0cc7ce
Partial-Bug: #1737854
2017-12-14 20:38:16 +08: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
2c7302e33e Merge "Api-guide: Address TODOs in user_concepts section" 2017-11-26 15:55:34 +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
Kevin_Zheng
f5ad8e206f Api-guide: Address TODOs in user_concepts section
Address TODOs in user_concepts section

Change-Id: Ibb604a0421f13066b88c75295abe91eb4a5a5d2e
2017-11-23 14:33:18 +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
Andreas Jaeger
4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
jichenjc
fd1bace5d0 Update doc to indicate nova-network deprecated
Change-Id: I45b586c82faebb1ba6cf2089fc3ec30b6e4761cb
TrivialFix: update doc to indicate nova-network deprecated already.
2017-08-31 08:08:33 +08:00
He Jie Xu
e83b884cf6 Remove the section about extensions from the API concept doc
The extensions are already removed from Nova API. So remove the
old section about the extensions from the API concept doc.

Change-Id: I29d6e85c23dd45e9f2452e58efb0feba70fb3ef4
2017-08-23 14:21:08 +08:00
Takashi NATSUME
9fbd7861dd api-ref: Add X-Openstack-Request-Id description
Add the description for the following items
in the API reference and the API guide.

* 'X-Openstack-Request-Id' header in request
* 'X-Openstack-Request-Id' header in response
* 'X-Compute-Request-Id' in response

Change-Id: Idd9181c1530eb9576da9941416b697a97c0cfb8d
Closes-Bug: #1693555
2017-07-10 14:03:14 +00:00
Matthew Treinish
acdc2da0e3 Remove cloudpipe APIs
This commit removes the cloudpipe API from nova. This has been
deprecated since change I415760ff634dd85974f0c3f79e788e633852efb5 and no
longer works without nova-cert and the pending removal of the deprecated
nova-network.

Implements bp remove-nova-cert
Change-Id: Ifd1fb13a5953cc66f9cc2561d30a9efcd3f4c92e
2017-05-04 16:13:45 +08:00
Matthew Treinish
2bcee77e3b
Remove nova-cert
This commit removes nova-cert which has been deprecated since change
Id7a1fc943cbe6d860a50d3cc776717b55351004b. The APIs have been hard coded
to return a 410 whenever they're called now. For the API ref a new
section for obsolete apis is added to the bottom of the page and the
certificates api ref is moved there.

Implements bp remove-nova-cert

Change-Id: I2c78a0c6599b92040146cf9f0042cff8fd2509c3
2017-04-27 22:28:01 -04:00
Cao Xuan Hoang
d99fd590b0 Removes unnecessary utf-8 encoding
trivialfix

Change-Id: I1294ecb5e85c9bf70a23992e92eeccfd35362551
2016-12-20 10:27:01 +07: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
Ianeta Hutchinson
e5f379f84b Fix small RST markup errors
Change-Id: Ie9f328ecaa5f6771538dec74572b6d06c0f19b02
2016-09-29 16:24:21 +00:00
Jenkins
d7062c714e Merge "Remove last sentence" 2016-09-26 13:12:57 +00:00
Nguyen Phuong An
146499fa43 Remove last sentence
This patchs removes last sentence because it contains wrong infomation.
Current we are using RST and YAML instead of WADL and it isn't
really a machine processable version any more.

Change-Id: I45251411be6afcba69800f198e0cc47df77e7626
2016-09-26 15:23:09 +07:00
Jenkins
ae82a01627 Merge "Fix a typo from ID to Id" 2016-09-21 03:04:47 +00:00