894 Commits

Author SHA1 Message Date
Zuul
bff3fd1cdb Merge "API: Remove evacuate/live-migrate 'force' parameter" 2019-02-09 22:55:34 +00:00
Stephen Finucane
36a91936a8 API: Remove evacuate/live-migrate 'force' parameter
Add a new microversion that removes support for the aforementioned
argument, which cannot be adequately guaranteed in the new placement
world.

Change-Id: I2a395aa6eccad75a97fa49e993b0300bdcfc7258
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Implements: blueprint remove-force-flag-from-live-migrate-and-evacuate
APIImpact
2019-02-08 17:05:19 -05:00
Matt Riedemann
46a9d73ad8 api-ref: fix link to flavor extra specs docs
This fixes the link, re-words it a bit, moves it to the main
description (since it applies to PUT also) and drops the note
since we don't need note formatting for linking in reference
material.

Closes-Bug: #1814953

Change-Id: Ia24cda353bdcadf3fe8405aac588e8abf1100608
2019-02-06 14:49:18 -05: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
Zuul
920ac6d8e1 Merge "Fix up force live migration completion docs" 2018-12-27 23:37:48 +00:00
Zuul
5c80aeb252 Merge "api-ref: sort parameters for limits, quotas and quota classes" 2018-12-17 16:36:11 +00:00
Matt Riedemann
18fbee57b4 Fix up force live migration completion docs
This change does a few things:

* Links live_migration_completion_timeout to the config
  option guide.

* Links the force complete API reference to the feature support
  matrix to see which drivers support the operation.

* Fixes the server status mentioned in the troubleshooting for
  the force complete API reference (a live migrating server
  status is MIGRATING, not ACTIVE). The same text is copied to the
  abort live migration API reference troubleshooting for
  consistency (and since using the server status is more natural than
  the task_state).

* Links to the admin guide for troubleshooting live migration
  timeouts.

Change-Id: I496d3f4b99e3d7e978c7ecb13ab3b67023fcb919
Closes-Bug: #1808579
2018-12-14 15:13:59 -05:00
Zuul
01cea1a045 Merge "api-ref: Add a description about sort order" 2018-11-12 06:50:27 +00:00
Takashi NATSUME
084ce9b28a api-ref: Add a description about sort order
Add a description about the sort order
in the "List Migrations" (GET /os-migrations) API.

Change-Id: Iaa8e264ca95b69f3c97a6848918862ee22922de1
Closes-Bug: #1801789
2018-11-09 23:56:56 +00:00
liuyamin
8ad11697f9 Fix version details API does not return 200 OK
When use version details api http://ip/compute/v2 to get api details,
it does not return 200 OK, and the return value is empty.

This change is to correct the version details API URL.

Change-Id: I6befb4df6b688ae8c59671781c4e7b338a16462c
Closes-Bug: #1802247
2018-11-08 16:03:33 +08:00
Zuul
88db2f9c0a Merge "Add restrictions on updated_at when getting instance action records" 2018-10-29 04:33:15 +00:00
Zuul
9a201632d3 Merge "Add restrictions on updated_at when getting migrations" 2018-10-27 00:42:54 +00:00
Zuul
d223b1298b Merge "api-ref: Remove unnecessary minimum microversion" 2018-10-26 18:31:36 +00:00
Takashi NATSUME
4c531a5b94 api-ref: Add descriptions of error cases
In the following APIs, the 'changes-since' query parameter must be
earlier than or equal to 'changes-before' query parameter
otherwise the API returns 400.

* GET /servers
* GET /servers/detail

Add the description in each parameter.

Change-Id: Ieb26275deac2ddee3768a0fad7f37dc5795fb5c0
2018-10-25 07:46:30 +00:00
Takashi NATSUME
8a0e2a1085 api-ref: Remove unnecessary minimum microversion
A minimum microversion description that is the same as
the microversion the API is newly added is redundant
in parameters. So remove them.

Change-Id: I3e1ca88cac3a52a8b44e26f051a51a6db77a3231
Closes-Bug: #1799893
2018-10-25 16:37:21 +09:00
zhangbailin
3d4a7021db Add restrictions on updated_at when getting instance action records
If ``changes-before`` is less than ``changes-since`` in requested,
there will get empty data when querying in db, so add the limit of
these parameters. If ``changes-before`` < ``changes-since``, will
be returned 400.

Closes-Bug: #1796009
Change-Id: I44546bc9798708a48a250cc3a21bdbcabe2649e1
2018-10-24 11:14:26 -04:00
zhangbailin
a3a0068929 Add restrictions on updated_at when getting migrations
If ``changes-before`` is less than ``changes-since`` in requested,
there will get empty data when querying in db, so add the limit of
these parameters. If ``changes-before`` < ``changes-since``, will
be returned 400.

Closes-Bug: #1796008
Change-Id: I2a39ac5a9fe969d383099b4e766c46ad05d9f67c
2018-10-24 11:11:49 -04:00
Matt Riedemann
014cf69415 Fix block_device_mapping_v2 mention in server create API reference
The parameter is "block_device_mapping_v2" with underscores
not dashes.

Change-Id: I10300b5614b6fd91a1992e6e22fb776815206795
2018-10-17 16:14:21 -04:00
Zuul
396156eb13 Merge "Add microversion 2.67 to support volume_type" 2018-10-13 18:46:09 +00:00
zhangbailin
c7f4190af2 Add microversion 2.67 to support volume_type
Add a new microversion 2.67 to support specify ``volume_type``
when boot instances.

Part of bp boot-instance-specific-storage-backend
Change-Id: I13102243f7ce36a5d44c1790f3a633703373ebf7
2018-10-12 02:57:58 -04:00
Takashi NATSUME
95d2f3c8e7 api-ref: Remove a description in servers-actions.inc
In the "Servers - run an action (servers, action)" section,
it says that you can attach a volume to a server.
But there are no APIs to attach a volume to a server
in the section.
The API is in the "Servers with volume attachments
(servers, os-volume_attachments)" section.

So remove the description in
the "Servers - run an action (servers, action)" section.

TrivialFix
Change-Id: I0bbfa98385930e21ac12815675851036c9a77621
2018-10-09 09:32:28 +09:00
Takashi NATSUME
cfaf8e571f api-ref: Move the evacuate action to admin action
The evacuate action can be performed by administrators only by default.
But there is the description of the evacuate action in
the "Servers - run an action (servers, action)" section.

It should be in the "Servers - run an administrative action
(servers, action)" section.
So move to the description of the evacuate action
into the administrative action section.

Change-Id: Iafdd77c14c702af24dbb3f5a3adecc45b3014c48
Closes-Bug: #1796054
2018-10-04 19:20:22 +09:00
Matt Riedemann
183ba80ec5 api-ref: add 'migrations' param to GET /os-migrations
The response parameter table for the GET /os-migrations
API reference was missing the top level "migrations"
parameter which is the list of migration objects.

While in here, fix the fake "Done" status to "done"
in the sample. There is nothing in nova that uses a
status of "Done". The evacuate operation uses "done".

Change-Id: I1e193237e9aec05395cd2760d96e70db7791409b
2018-09-25 17:06:02 -04:00
Takashi NATSUME
f2b2f0e1d4 api-ref: Fix wrong bold decoration
In the 'DELETE /os-floating-ips/{floating_ip_id}' API,
"Error response codes: badRequest(400), unauthorized(401),
forbidden(403)," is bold.
But it should not be bold.
So fix it.

TrivialFix
Change-Id: Ic2d1ae2856406600c9dd3273d21dd2f18e56c1e9
2018-09-25 16:06:57 +09:00
Zuul
2274c08460 Merge "Remove deprecated hide_server_address_states option" 2018-09-21 13:58:57 +00:00
Zuul
1c1a111e5a Merge "Resource retrieving: add changes-before filter" 2018-09-21 11:48:29 +00:00
Matt Riedemann
9b69afd457 Remove deprecated hide_server_address_states option
The hide_server_address_states config option and related
policy rule were deprecated in Queens:

  I6040e8c2b3e132b0dfd09f82ae041b4786a63483

They are now removed in Stein as part of the API extension
merge effort.

Part of blueprint api-extensions-merge-stein

Change-Id: Ib3582038274dedbf524ffcaffe818ff0e751489d
2018-09-19 11:36:44 -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
zhufl
aa06c053e6 Fix some typos in nova api ref doc
* returnd
* specifiled
* obejct

Change-Id: I57af28fd3934b036c65e284d40ff27d043cd2431
2018-09-18 15:36:05 +08:00
Matt Riedemann
f3fa4eef4c api-ref: add a warning about calling swap volume directly
Per the ML thread on this [1] we should have a warning in
the API discouraging people from swapping volumes directly
in nova.

[1] http://lists.openstack.org/pipermail/openstack-dev/2018-August/133527.html

Change-Id: If095e1d9bae8be7a23212684ed9d2e043c0cbf59
2018-08-24 17:47:01 -04:00
Matt Riedemann
65d9d4ebc2 api-ref: fix volume attachment update policy note
Since change Iac03258735f3d856a474ab96fe9b0a087e32906f the
PUT /servers/{server_id}/os-volume_attachments/{volume_id}
(swap volume) API is admin-only by default. This fixes the
documentation in the API reference.

Change-Id: I9e7fe40536cf5f03d97eb80fd4459b5a74e92f76
Related-Bug: #1522705
2018-08-24 17:28:03 -04:00
Zuul
fbc8ab2025 Merge "Making consistent used of GiB and MiB in API ref" 2018-08-22 04:03:01 +00: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
Petersingh Anburaj
eebffb3879 Making consistent used of GiB and MiB in API ref
This patch will replace all GB with GiB and MB with MiB
to have a consistent use of units in the compute API reference
and the placement API reference.

Co-Authored-By: Takashi Natsume <natsume.takashi@lab.ntt.co.jp>
Change-Id: Ie40413752b591b222ff29dbe975ddd7d10638eca
Closes-Bug: #1752340
2018-08-16 22:42:00 +00:00
Zuul
8947097047 Merge "api-ref: fix GET /flavors?is_public description" 2018-08-15 13:33:56 +00:00
Zuul
2813e78558 Merge "Quota details for key_pair "in_use" is 0." 2018-08-10 17:57:47 +00:00
Matt Riedemann
eff376b9fc api-ref: fix GET /flavors?is_public description
A couple of things are fixed here:

1. The type in the schema for the is_public query param
   is string, not boolean.

2. Since it's a string, the normal 1/yes/0/no types of
   "booleans" are allowed so document that along with
   the default.

3. Also mention that is_public='None' must be passed for
   an admin user to list both public and private flavors
   in a single request.

Change-Id: Idcb700b69f13217f68434fd6a54439cc277f8998
Partial-Bug: #1784782
2018-08-10 08:49:08 -04:00
Vishakha Agarwal
fac7d6f2d2 Quota details for key_pair "in_use" is 0.
This patch updates the api-ref for 'in_use'
field of quota details for keypair which is
always 0 as it is user dependant parameter.

Closes-Bug: #1644457
Change-Id: I0323c411126314ddf3d689dc3120b039256ae81a
2018-08-10 10:33:59 +05:30
Zuul
9d546732c8 Merge "Update the parameter explain when updating a volume attachment" 2018-08-09 17:44:47 +00:00
fpxie
a2a17c0625 Update the parameter explain when updating a volume attachment
When we update a volume attachment in nova api, we use volume_id instead
of attachment_id in params in latest api.

Change-Id: I5fc4d0ba3bb1c49dfaba2b2eed056441509cb9da
2018-08-09 02:45:19 +00:00
Zuul
e0724cbb12 Merge "xx_instance_type_id in list_migrations should be integer" 2018-08-08 21:19:37 +00:00
Zuul
e8a73c4008 Merge "api-ref: Add descriptions for rebuild" 2018-08-08 03:19:11 +00:00
zhufl
ef7c961726 xx_instance_type_id in list_migrations should be integer
new_instance_type_id and old_instance_type_id in response
of list_migrations should be integer, not string.

Besides, this flavor id is not a common one specified by
users, but an internal one, so this is also to add a NOTE
to avoid the confusion.

"old_instance_type_id": 5140

https://developer.openstack.org/api-ref/compute/#list-migrations

Change-Id: I43c454ac1d7f7ef413d44fe411459e989611cadb
2018-08-08 09:32:23 +08:00
Takashi NATSUME
330c950908 api-ref: Add descriptions for rebuild
Add descriptions about specifying a new image and
asynchronous postconditions in the rebuild operation
in the compute API reference.

Change-Id: I0fd136d07dffc2be845b4b9330fae98c7115789b
Closes-Bug: #1784387
2018-08-07 23:57:22 +00:00
Yikun Jiang
00b585a1b9 Add microversion info in the os-server-groups API samples
The os-server-groups samples are using 2.64 but don't explicitly say
that, so we need something like "(v2.64)" in the os-server-groups.inc.

In this patch, we add microversion info in the os-server-groups API
samples.

Change-Id: Ia7e25ceba532e6cfd0ed18cf3cc8113512d50323
Closes-bug: #1785415
2018-08-07 22:47:44 +00:00
Zuul
b046a99844 Merge "Complete the api-ref of security group rule" 2018-08-02 19:06:40 +00:00
Zuul
7f9cdb5d6d Merge "Fix being able to hard reboot a pausing instance" 2018-07-31 10:32:41 +00:00
Zuul
bb5ff6f6c3 Merge "api-ref: document user_data length restriction" 2018-07-30 07:48:25 +00:00
Zuul
dd6d752966 Merge "Fix ServerMigrationSampleJsonTests to use sample files from version dir" 2018-07-29 06:36:43 +00:00
Matt Riedemann
ca70309987 api-ref: document user_data length restriction
user_data for server create and rebuild is limited to
65535 bytes in the schema, so we should be clear about
this limit in the API reference.

Change-Id: I61fe749ef20229744e1420779ae8128192704554
2018-07-26 21:56:26 -04:00