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
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
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
Add description about server status in active, shutoff,
error can accept a rebuild action.
Closes-Bug: 1775665
Change-Id: Id52acb9fdb264b337a6a9748049aeecd22901bf4
This change adds support for the trusted_image_certificates parameter,
which is used to define a list of trusted certificate IDs that can be
used during image signature verification and certificate validation. The
parameter may contain a list of strings, each string representing the ID
of a trusted certificate. The list is restricted to a maximum of 50 IDs.
The list of certificate IDs will be stored in the trusted_certs field of
the instance InstanceExtra and will be used to verify the validity of
the signing certificate of a signed instance image.
The trusted_image_certificates request parameter can be passed to
the server create and rebuild APIs (if allowed by policy):
* POST /servers
* POST /servers/{server_id}/action (rebuild)
The following policy rules were added to restrict the usage of the
``trusted_image_certificates`` request parameter in the server create
and rebuild APIs:
* os_compute_api:servers:create:trusted_certs
* os_compute_api:servers:rebuild:trusted_certs
The trusted_image_certificates parameter will be in the response
body of the following APIs (not restricted by policy):
* GET /servers/detail
* GET /servers/{server_id}
* PUT /servers/{server_id}
* POST /servers/{server_id}/action (rebuild)
APIImpact
Implements blueprint: nova-validate-certificates
Change-Id: Iedd3fea0e86648fae364f075915555dcb2c4f199
The allowed task states for a hard reboot include 'pausing'
but the instance.save(expected_task_states) doesn't include
'pausing', so if you try to hard reboot a pausing instance
it will fail with UnexpectedTaskStateError.
This makes the expected_task_states passed to Instance.save
use the same list of allowed task states that we use in the
check_instance_state decorator, and re-writes the unit test
to use an actual database to verify the Instance.save()
behavior and task state check in the DB API.
While we're at it, the API reference is updated to indicate
the allowed states for each type of reboot.
Change-Id: I5a21350e48a637e581d269fb567bb96c1899e174
Closes-Bug: #1768927
The docs had three things wrong:
1. The server status would be VERIFY_RESIZE, not VERIFY_RESIZED.
2. The RESIZED value is on the OS-EXT-STS:vm_state field, not
vm_status.
3. The migration record status must be "finished", which is what
gets set on the migration record in the _finish_resize() method
in ComputeManager and used in the comptue API.confirm_resize()
method. "confirming" status is what the API sets the migration
record to before casting to nova-compute to finish the
confirmation.
Stepping back, this is too many conditionals for what is really
needed. So rather than fix all three items individually, this
change simply fixes the first one and removes the other two since
the 'status' is based on the 'vm_state' internally, and a non-admin
user cannot list migrations anyway, and the _finish_resize()
method sets the migration status *before* the vm_state.
Closes-Bug: #1764878
Change-Id: Ib751686880ee824cf0693a649f47c828f515b471
It is a follow-up for If01b2dcfa9df8c0e80ad1da65115204fe321891b.
The 'progress' parameter has been changed to an optional parameter
in If01b2dcfa9df8c0e80ad1da65115204fe321891b.
Optional parameters should be after required parameters.
So fix parameter order in rebuild action.
And fix 'adminPass' as well.
Change-Id: I38e0cdd73e9b81b5c4c8bd69c1139f99db3c7773
This adds the same note for volume-backed instances not being
supported for the server rescue action as exists for the createBackup
action.
Change-Id: If4ba24f2fe15f479c353d0ea69bf0f1454540ef0
This microversion makes the following changes:
1. Deprecates personality files from POST /servers and the rebuild
server action APIs.
2. Adds the ability to pass new user_data to the rebuild server
action API.
3. Personality / file injection related limits and quota resources
are removed from the limits, os-quota-sets and os-quota-class-sets
APIs.
Implements blueprint deprecate-file-injection
Change-Id: Ia89eeb6725459c35369e8f790f68ad9180bd3aba
This patch adds `key_name` param to instance rebuild
API. Then the user could reset the instance keypair
when rebuilding. If set key_name to None, the API
will unset the keypair of the instance.
APIImpact
Implements blueprint: rebuild-keypair-reset
Change-Id: I23886a89c25f811cfbe7e2500ce7ff52f9162966
We've had several bugs about this over the years, and until we
actually decide to fix it (or not), we should point out the known
limitation that volume-backed root disks are not replaced during
a rebuild.
Like, if you have a volume-backed instance and rebuild with a new
image, the root disk is still the volume with the original image.
Change-Id: I145cab88f782e4b1e630cc432322bc8436413e71
Related-Bug: #1482040
We already mention the preserve_ephemeral parameter in the request
parameters table, including the note that it's only useful for
baremetal instances, so we don't need to mention it again in the
description of the API.
Also adds a space between some list error codes.
Change-Id: I8712f0fdd06eee1bb9af439621481d1c69b6244c
Add a new microversion to change the flavor field in the server
details to display a subset of the flavor information instead of
just a link to the original flavor.
This is more reliable since it shows the actual instance size, while
the flavor may have been deleted/recreated in the meantime or the
flavor extra-specs may have been modified.
Implements: blueprint instance-flavor-api
Change-Id: If646149efb7eec8c90bf7d07c39ff4c495349941
* Example for the rebuild action
The functional test is modified and
the example is replaced with v2.26 examples.
* Example for the rescue action
The example in API reference is replaced with
the example with 'rescue_imgae_ref'.
Parameters for the rebuild action and the rescue action
are also fixed.
The patch completes the parameter verification and
the example verification of servers-actions.inc.
Change-Id: Iaf8808b13d1fdfead50da4cd447b3893578f76dd
Implements: blueprint api-ref-in-rst-pike
Add a functional test for 'removeFloatingIp' action.
Rename the example file for 'addFloatingIp' action
to clarify that it is a request body example.
Change-Id: Ic865318fa640eb17d1317fb3d5f064788ebf44e7
This changes the response for the createImage and createBackup
server action APIs to no longer return a Location header and instead
returns a json dict body with the snapshot image ID. This is done
in a new microversion.
Implements blueprint remove-create-image-location-header-response
Closes-Bug: #1679285
Change-Id: Idc899ee76b8265b1c9e0871b6c7c277424cdd442
The createBackup API is by default an admin-or-owner API, so it
should live in server-actions rather than server-admin-actions.
Change-Id: Ifdc08a1df39f30944d45e2001d590b34a963d062
Closes-Bug: #1679314
The following APIs which are considered as proxies of Neutron networking
API, are deprecated and will result in a 404 error response in new
Microversion:
POST /servers/{server_uuid}/action
{
"addFixedIp": {...}
}
POST /servers/{server_uuid}/action
{
"removeFixedIp": {...}
}
POST /servers/{server_uuid}/action
{
"addFloatingIp": {...}
}
POST /servers/{server_uuid}/action
{
"removeFloatingIp": {...}
And the nova-network specific API for query server's interfaces is
deprecated also:
GET /servers/{server_uuid}/os-virtual-interfaces
Partial implement blueprint deprecate-multinic-proxy-api
Change-Id: I1848db384a825d3b166f113b30ebad92113af8e5
This patch fixes the parameters of the following actions.
* removeSecurityGroup
* resize
* resume
* revertResize
Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.
Change-Id: Ie470138ac53404369f4fc717bf979b94060c5652
Implements: blueprint api-ref-in-rst-pike
This patch fixes the parameters of the following actions.
* lock
* pause
* reboot
* removeFloatingIp
Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.
Change-Id: I33210b5d8cfb359e4cc9ef37fe74b71d30a9acc5
Implements: blueprint api-ref-in-rst-pike
This patch fixes the parameters of the following actions.
* addSecurityGroup
* changePassword
* confirmResize
* createImage
Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.
Change-Id: Ifaa1ed25c034e649ea4012f4998c571c38d404a1
Implements: blueprint api-ref-in-rst-pike
* POST /servers
The 413 response code has not been expected
since I470b53af45ff47c1dec98d09d7a426a29ca1efc6.
So remove 413.
* POST /server/{server_id}/action
In 'Rebuild' action, the 413 response code has not been expected
since I470b53af45ff47c1dec98d09d7a426a29ca1efc6.
So remove 413.
In 'Rescue' action, the normal response code is actually 200
instead of 202.
So fix it.
Change-Id: I6e91d3ac751777f48ab084395a66cb3f83bfcca2
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1677452
This commit fix the below doc issue for adminPass
-'adminPass' attrbiure is only return in response if
'enable_instance_password' configuration option is set to true
- evacuate API stop returning adminPass from 2.14 microversion
so max version for this field is 2.13.
- if 'adminPass' is not present in request then, operation auto generate one.
Change-Id: I636657ed30b33da0a2df73b222c4ce5d8388a3d8
The original changed description tried to explain the instance
data still exists after the API operation, but that was not clear.
This patch makes it clear as possible for users.
In addition, this patch removes the related sentence of os-start
to avoid the same confusion.
Change-Id: I46c4d24a67717807f4c6650a739f7855108783e9
snapshot action nova will return image URL in response header
better to provide this info to end user for their reference.
Also, the backup header description is changed as well.
Change-Id: I15cf228b4a5a2d0dbae5fa76ec6821487e7808ed
Closes-Bug: 1657998
Almost all proxy APIs were deprecated in microversion 2.36.
But the sub-resource image-metadata of image was forgotten to deprecate.
This patch deprecates the image-metdata API from 2.39.
Implements blueprint deprecate-image-meta-proxy-api
Closes-bug: #1614578
Change-Id: I5507337ab6fe4a377f66dec3fe275d75618cd7b4
- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
Review and change as needed.
Implements: bp/api-ref-in-rst-ocata
Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
As described in the bug, the addFloatingIp parameter
in the request body is an object, not a string. And we
didn't actually have an example request, so one is added
here to further clarify the API.
Change-Id: I366ba880cf13558291da286e6524327cafcccf1f
Closes-Bug: #1636185
This fixes the name parameter which should be referencing the optional
server name instead of the security group name. It also deletes an entry
in the parameters.yaml which is not referenced anywhere.
Change-Id: I38abe55aa46f54a22468e21188e0cd5ef2c63244
Since servers-actions.inc is too big, this job will be divided
into several patches.
Change Ia1409a4414248702718f64851b7dc892ea71d9c7 will be the
last one.
This patch fixes the following common problems in the file:
1. Parameter ``server_id`` is in the path, so it should be
``server_id_path``.
2. Add description for those responses without any content.
3. Remove useless words.
Change-Id: I81118d7890f37ee3124513136ef52af93d7c5dc0
Implements: blueprint api-ref-in-rst
The revert resize action's documentation appears to have been copied
from the documentation for confirm resize, and missed replacing the
word 'confirm' with 'revert' in one case. This fixes that.
It also gives incorrect information about the states involved through
the revert process. This also corrects that.
Change-Id: Ib2436da238a4a7b71454ecfee81ede4054b3018e
Closes-Bug: #1593295
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
Verify and update the response codes for the methods
based on what is in the code.
part of blueprint: api-ref-in-rst
Change-Id: Ib60e82b320ac7db3c2b50005f420db0aa43de492
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.
It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.
Part of bp:api-ref-in-rst
Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
