864 Commits

Author SHA1 Message Date
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
ghanshyam
064f215172 Fix ServerMigrationSampleJsonTests to use sample files from version dir
The ServerMigrationSampleJsonTests functional tests set up
``self.api.microversion`` to 2.22 in its' setUp(), which use
sample files from non version dir.

For consistency, this commit makes these tests to use sample
files from versioned dir.

Change-Id: I9af2348cf7dba53e0fef4054bcedcd5b0c626f50
2018-07-19 05:13:24 +00:00
ghanshyam
449da03245 Remove "DEPRECATED" tag from Obsolete APIs
APIs which are being Obsoleted and return 410 like nova-net
only APIs, have been moved to "Obsolete API" section in api-ref.

In favour of moving them in "Obsolete API" section, "DEPRECATED"
tag on those API ref can be removed to avoid confusion whether
these APIs are deprecated or gone.

Part of blueprint remove-nova-network

ref- https://review.openstack.org/#/c/567682/1/api-ref/source/os-fping.inc@4

Change-Id: I47eaf08a9c06e33d707fdfe88f6771e165f377b5
2018-07-18 22:23:45 -04:00
Stephen Finucane
db294b1e33 Remove support for /os-floating-ip-dns REST API
Drop support for the os-floating-ip-dns API which has been deprecated
since Newton:

  Idca478c566f9a7b5b30a3172453ce7c66d9fd8f0

This API now returns a 410 response for all routes.

Unit tests are removed and the functional API sample tests are just
asserting the 410 response now.

The API sample docs are left intact since the API reference still builds
from those and can be considered more or less branchless, so people
looking at the API reference can apply it to older deployments of nova
before os-floating-ip-dns was removed.

The release note added for previous nova-network API removals is
amended to note this additional change.

Part of blueprint remove-nova-network

Change-Id: I0c4b586292814b8483226aee315f41cbefc86a1e
2018-07-18 22:23:45 -04:00
Stephen Finucane
823c4e840d Remove support for /os-floating-ips-bulk REST API
Drop support for the os-floating-ips-bulk API which has been deprecated
since Newton:

  Idca478c566f9a7b5b30a3172453ce7c66d9fd8f0

This API now returns a 410 response for all routes.

Unit tests are removed and the functional API sample tests are just
asserting the 410 response now.

The API sample docs are left intact since the API reference still builds
from those and can be considered more or less branchless, so people
looking at the API reference can apply it to older deployments of nova
before os-floating-ips-bulk was removed.

The release note added for previous nova-network API removals is
amended to note this additional change.

Part of blueprint remove-nova-network

Change-Id: I89d081108b398d8efba9636279088c61349b21e6
Depends-On: https://review.openstack.org/582945
2018-07-18 22:23:45 -04:00
Kevin_Zheng
4cae503767 API: add support to abort queued live migration in microversion 2.65
This patch bumped API microversion to 2.65 to add support for
abort live migrations in ``queued`` and ``preparing`` status.

Part of blueprint abort-live-migration-in-queued-status

Change-Id: I4636a8d270ce01c1831bc951c4497ad472bc9aa8
2018-07-16 13:57:11 -04:00
Zuul
ae40af621f Merge "Microversion 2.64 - Use new format policy in server group" 2018-07-16 15:41:57 +00:00
Yikun Jiang
5cdb1ce26b Microversion 2.64 - Use new format policy in server group
Enable users to define the policy rules on server group policy
to meet more advanced policy requirement. This microversion
brings the following changes in server group APIs:

* Add  ``policy`` and ``rules`` fields in the request of POST
  ``/os-server-groups``.
* The ``policy`` and ``rules`` fields will be
  returned in response body of POST, GET ``/os-server-groups``
  API and GET ``/os-server-groups/{server_group_id}`` API.
* The ``policies`` and ``metadata`` fields have been removed
  from the response body of POST, GET ``/os-server-groups`` API
  and GET ``/os-server-groups/{server_group_id}`` API.

Part of blueprint: complex-anti-affinity-policies

Change-Id: I6911e97bd7f8df92511e90518dba21c127e106a5
2018-07-13 10:43:42 +08:00
ghanshyam
917d8a41a2 Complete the api-ref of security group rule
Adding the correct path of examples in security
group rules api-ref.

Change-Id: I9b7ee5d6da7837901089861d0252f9792a817ce4
2018-07-12 07:12:20 +00:00
Takashi NATSUME
3b01a728ce api-ref: Example verification for servers.inc
This patch verifies request and response bodies in servers.inc.

Change-Id: I9266e7513ed6eb00599dc766081ce81014a209bb
Closes-Bug: #1739573
2018-07-09 14:47:46 +00:00
Zuul
0ef62de888 Merge "Simplify instance name generation" 2018-07-02 13:18:04 +00:00
Zuul
4c9f63463a Merge "update the description of hypervisor statistics response" 2018-06-29 05:44:47 +00:00
Zuul
d28a0b5f84 Merge "Mention server status in api-ref when rebuild" 2018-06-28 12:23:50 +00:00
jichenjc
1a079a6394 Mention server status in api-ref when rebuild
Add description about server status in active, shutoff,
error can accept a rebuild action.

Closes-Bug: 1775665

Change-Id: Id52acb9fdb264b337a6a9748049aeecd22901bf4
2018-06-28 00:21:13 +00:00
Zuul
dbfba39513 Merge "Update API reference for os-floating-ip-pools" 2018-06-27 10:24:24 +00:00
Zuul
224a7e3798 Merge "Fix API reference for os-floating-ip-dns" 2018-06-27 10:24:15 +00:00
Zuul
3710ded861 Merge "Fix API reference for os-floating-ips-bulk" 2018-06-27 10:24:07 +00:00
Zuul
351faa959f Merge "Remove support for /os-fixed-ips REST API" 2018-06-26 21:01:35 +00:00
Matt Riedemann
8d4db5b88a Update API reference for os-floating-ip-pools
The os-floating-ip-pools API is implemented for both
nova-network and neutron. When using neutron, it justs
lists external network names.

Since it's a deprecated proxy to neutron we won't remove
it as part of blueprint remove-nova-network, but we can
update the API reference to explain how to achieve the
equivalent functionality in the networking service API,
so that's done here.

Change-Id: Ieb4c7a0657929f66ed5b642c5941e65aee24372d
2018-06-26 09:47:23 -04:00
Matt Riedemann
47f646ccf2 Fix API reference for os-floating-ip-dns
The generic warning in here about being a proxy to
neutron is incorrect since these APIs don't proxy
anything to neutron and won't work if you're using
neutron, so the warning is updated.

Part of blueprint remove-nova-network

Change-Id: I8b7638bb0835711ef174d6caf1b53e4a1808ef53
2018-06-26 09:41:07 -04:00
Matt Riedemann
c62b377020 Fix API reference for os-floating-ips-bulk
The generic warning in here about being a proxy to
neutron is incorrect since these APIs don't proxy
anything to neutron and won't work if you're using
neutron, so the warning is updated.

Part of blueprint remove-nova-network

Change-Id: I6f88108ba81dfb8f47fb56a35aa6abc2bad0d710
2018-06-26 09:40:54 -04:00
jichen
5097309f89 Remove support for /os-fixed-ips REST API
This drops support for the os-fixed-ips compute REST API which has been
deprecated since
Newton: I1a8a44530be29292561e90d6f7bd7ed512a88ee3

Now it returns 410 response. Unit tests are removed and the functional API
sample test is just asserting the 410 response now. The API sample docs are
left intact since the API reference still builds from those and can be
considered more or less branchless, so people looking at the API reference
can apply it to older deployments of nova before os-fixed-ips was removed.

Part of blueprint remove-nova-network

Change-Id: I61f758ff9285448d431b45f67c70286082b4ee90
2018-06-26 09:20:28 -04:00