195 Commits

Author SHA1 Message Date
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
Balazs Gibizer
f06ff5949f Enable evacuation with qos ports
Previous patch [1] implemented support for evacuation of servers with
neutron ports having resource request. So this patch removes the API
check that rejected such operations and document the new feature.

[1] Id9ed7a82d42be8ffe760f03e6610b9e6f5a4287b

Change-Id: Id5f2f4f22b856c989e2eef8ed56b9829d1bcefb6
blueprint: support-move-ops-with-qos-ports-ussuri
2019-10-25 16:14:22 +00:00
Takashi NATSUME
9a5da92524 api-guide: Fix available info in handling down cells
Add the 'security_groups' parameter as available infomation
in the "List Servers Detailed" API (GET /servers/detail)
when there is a down cell.

Change-Id: I9653a46478c80b343a5a5f8d6b1607688538b1d5
CLoses-Bug: #1846559
2019-10-10 21:28:02 +00:00
Balazs Gibizer
a412d72dec Allow resizing server with port resource request
This patch adds functional coverage for such resize. No extra code
changes were needed on top of the migrate patches to make resize work.

Now that the nova code supports the resize this patch removes the
check from the API that rejected the operation.

Note that in the spec [1] we agreed not to introduce new microversion
for this change but treat it as a bugfix. The current change also makes
it possible to accept the resize of these servers with _any_
microversion.

[1] https://specs.openstack.org/openstack/nova-specs/specs/train/approved/support-move-ops-with-qos-ports.html#rest-api-impact

blueprint: support-move-ops-with-qos-ports

Change-Id: Id0ee10e8d323786f4d79c82e3f05b48e76bd0956
2019-09-12 10:35:22 -04:00
Balazs Gibizer
fee98b7147 Allow migrating server with port resource request
Now that the nova code supports such a migration this patch removes the
check from the API that rejected the operation.

Note that in the spec [1] we agreed not to introduce new microversion
for this change but treat it as a bugfix. The current change also makes
it possible to accept the migration of these servers with _any_
microversion.

[1] https://specs.openstack.org/openstack/nova-specs/specs/train/approved/support-move-ops-with-qos-ports.html#rest-api-impact

Change-Id: I4bda569cc7c247e83219276282724c77e760ddcd
blueprint: support-move-ops-with-qos-ports
2019-09-12 10:32:51 -04:00
Stephen Finucane
b01676c418 Remove 'hw:cpu_policy', 'hw:mem_page_size' extra specs from API samples
In a future change, the use of 'hw:cpu_policy' will require a host to
report PCPU inventory. Rather than modify the fake driver used in these
tests to report such inventory, just use a different extra spec,
'hw:numa_nodes'. This has the added bonus of being supported by both the
libvirt and Hyper-V virt drivers, unlike 'hw:cpu_policy' and
'hw:mem_page_size', which are only supported by the libvirt virt driver.

Change-Id: Id203dc07f08557b1b094ec72e1df3493ec9524b1
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-08-27 17:00:46 +01:00
Matt Riedemann
163482e0e1 doc: fix links for server actions in api guide
The section about server actions is talking about the
os-instance-actions API but linking to the server actions
section in the API reference. This retains the link to the
server actions section but changes the "for more details"
link to the actual os-instance-actions reference.

Change-Id: Icb5c4cadd1c552f44bfadefd055c07ea38df0eaa
2019-07-26 15:47:02 -04: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
Zuul
09801f226b Merge "api-guide: better explain scheduler hints." 2019-06-21 21:16:37 +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
Stephen Finucane
009fd0f35b docs: Remove references to nova-consoleauth
We're going to remove all the code, but first, remove the docs.

Part of blueprint remove-consoleauth

Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-17 15:18:31 +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
Zuul
12ebe26823 Merge "Change some URLs to point to better targets" 2019-05-13 06:38:18 +00:00
zhufl
84afd12589 Change some URLs to point to better targets
This is to change some URLs to point to better or more accurate targets.

Change-Id: I1d450ba8bd2271a69f9380cc4d2b36ae3eefe09a
2019-05-13 00:52:23 +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
Balazs Gibizer
47287f6f94 Documentation for bandwidth support
blueprint: bandwidth-resource-provider
Depends-On: https://review.openstack.org/#/c/640390
Depends-On: https://review.openstack.org/#/c/621494

Change-Id: I166787e092e16857d20f89fba965be2a5509fb4b
2019-03-18 11:24:56 +01:00
Zuul
c7db20d140 Merge "Remove wrong description for auto resize confirm" 2019-03-04 14:04:35 +00: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
a0b1951d2a Add "links" in the response of "nova show" for a down-cell instance
The down-cell microversion 2.69 just recently merged and it returns
links in the response for GET /servers/detail and GET /servers but not
for GET /servers/{server_id} which was an oversight because that API
returns links normally.

We should include the links key in the 'nova show' case as well and this
patch does exactly that.

Typically this would require a microversion change but given the code
merged recently and is not yet released we are just fixing this
oversight through this patch without a microversion bump.

Closes-Bug: #1818131
Change-Id: I2ce03df994f59c37b5ce3102c4e7165d17701798
2019-03-01 13:02:14 +00:00
Yongli He
2cc7c0e589 Adds the server group info into show server detail API.
The server-groups UUID add to response of 'GET /servers/{id}',
'PUT /servers/{server_id}" and rebuild API
'POST /servers/{server_id}/action'.

Change-Id: I4a2a584df56ece7beb8b12c0ce9b0e6b30237120
Implements: blueprint show-server-group
Co-authored-by: Gerry Kopec <Gerry.Kopec@windriver.com>
Signed-off-by: Yongli He <yongli.he@intel.com>
2019-02-28 14:22:46 -05: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
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 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
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