summaryrefslogtreecommitdiff
path: root/api-ref/source
Commit message (Collapse)AuthorAgeFilesLines
...
| * | Remove 'os-consoles' APIStephen Finucane2019-11-224-65/+68
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Remove '/os-tenant-networks' REST APIStephen Finucane2019-11-221-6/+6
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | Like '/os-networks', we can't remove this in its entirety due to the fact that some of these are proxy URLs that also work with neutron. These are retained but everything else is nuked. Note that this highlights a bug in the API, whereby a missing 'objects.Network.cidr' value results in a value of 'None' being output over the API. Clearly this is incorrect, but it's probably not worth fixing for this deprecated API. Change-Id: I31cb0891144bdd7945479bb6692b0a533de4c5d0 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Remove (most) '/os-networks' REST APIsStephen Finucane2019-11-181-45/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. 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 these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Remove 'os-security-group-default-rules' REST APIStephen Finucane2019-11-182-11/+13
| | | | | | | | | | | | | | | | | | | | | | This is a nova-network-only API. As with previously removed APIs, this API now return a 410 response for all routes. There are some DB methods that were only used by this API. They will be removed separately in a future change. Change-Id: Iaa7fb6c548613164d33793822ee85339f9f7fefb Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Block deleting compute services with in-progress migrations"Zuul2019-11-161-0/+6
|\ \
| * | Block deleting compute services with in-progress migrationsMatt Riedemann2019-11-141-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This builds on I0bd63b655ad3d3d39af8d15c781ce0a45efc8e3a which made DELETE /os-services/{service_id} fail with a 409 response if the host has instances on it. This change checks for in-progress migrations involving the nodes on the host, either as the source or destination nodes, and returns a 409 error response if any are found. Failling to do this can lead to orphaned resource providers in placement and also failing to properly confirm or revert a pending resize or cold migration. A release note is included for the (justified) behavior change in the API. A new microversion should not be required for this since admins should not have to opt out of broken behavior. Change-Id: I70e06c607045a1c0842f13069e51fef438012a9c Closes-Bug: #1852610
* | | Merge "api-ref: re-work migrate action post-conditions"Zuul2019-11-161-6/+6
|\ \ \
| * | | api-ref: re-work migrate action post-conditionsMatt Riedemann2019-11-131-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a follow up to [1] and borrows the same wording from the resize action post-conditions except uses "migrate(d)" instead of "resize(d)" where appropriate. [1] I77830dfb738cd78c830dc3ce7ea88216c1eac7ef Change-Id: Id24cb48b1b70848d2ce7020d114a843c509ab81c
* | | | docs: update SUSPENDED server status wrt supported driversMatt Riedemann2019-11-141-2/+1
| |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Two things here: 1. The API guide was missing the hyper-v driver which supports the suspend operation. Rather than hard-code a list of supported drivers in the doc, this change just links to the entry in the feature support matrix. 2. The supported hypervisors mention in the API reference is removed because the end user using the API should not need to know or care what backend hypervisor on which their server is running. They can either suspend or not, but we don't need to mention the supporting drivers for that in the API reference. Change-Id: Ib76779a8e34b2c68b0f4af190f71576180360d0f Related-Bug: #1815403
* | | Merge ""SUSPENDED" description changed in server_concepts guide and API REF"Zuul2019-11-141-7/+7
|\ \ \
| * | | "SUSPENDED" description changed in server_concepts guide and API REFSharat Sharma2019-11-131-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The description of "SUSPENDED" server status was misguiding. Rewording it to make it more accurate. Change-Id: Ie93b3b38c2000f7e9caa3ca89dea4ec04ed15067 Closes-Bug: #1815403
* | | | Merge "Add support matrix for Delete (Abort) on-going live migration"Zuul2019-11-131-1/+3
|\ \ \ \ | |_|/ / |/| | |
| * | | Add support matrix for Delete (Abort) on-going live migrationKevin_Zheng2019-10-301-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The info of Delete (Abort) on-going live migration is missing in support matrix, it could be useful for users to consider using this feature. This patch adds it. Change-Id: I2f917627fa451d20b1fd1ff35025481a4e525084 Closes-Bug: #1808902
* | | | api-ref: re-work resize action post-conditionsMatt Riedemann2019-10-291-6/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change does a few things: 1. Moves the post-condition paragraph into an "Asynchronous Postconditions" section like other API references. 2. Drops the "RESIZED" VM status wording since what that probably meant was the server OS-EXT-STS:vm_state value would be "resized" but what was in the reference was (a) wrong and (b) redundant with the VERIFY_RESIZE status. 3. Re-words and links the resize_confirm_window config option wording since saying "if you set" a config option in the API reference does not really make sense since "you" (the non-admin cloud user) does not have control over how the cloud is configured. Change-Id: I77830dfb738cd78c830dc3ce7ea88216c1eac7ef
* | | | Add known limitation about resize not resizing ephemeral disksMatt Riedemann2019-10-291-0/+3
| |_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | It's a long known issue that resize does not resize ephemeral disks attached to the server yet we continue to get bugs about it and there is no one working on fixing it. As such this change adds a note to the API reference for the resize server action API mentioning the known limitation. Change-Id: I31ca3627f2d3ef5a8db5eecf3759cd304b059963 Related-Bug: #1558880
* | | Add image caching API for aggregatesDan Smith2019-10-152-0/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | | This adds a new microversion and support for requesting image pre-caching on an aggregate. Related to blueprint image-precache-support Change-Id: I4ab96095106b38737ed355fcad07e758f8b5a9b0
* | | Filter migrations by user_id/project_idzhangbailin2019-10-143-9/+46
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In microversion 2.80, the ``GET /os-migrations`` API will have optional ``user_id`` and ``project_id`` query parameters for filtering migrations by user and/or project: * GET /os-migrations?user_id=ef9d34b4-45d0-4530-871b-3fb535988394 * GET /os-migrations?project_id=011ee9f4-8f16-4c38-8633-a254d420fd54 * GET /os-migrations?user_id=ef9d34b4-45d0-4530-871b-3fb535988394&project_id=011ee9f4-8f16-4c38-8633-a254d420fd54 And expose the ``user_id`` and ``project_id`` fields in the following APIs: * GET /os-migrations * GET /servers/{server_id}/migrations * GET /servers/{server_id}/migrations/{migration_id} Co-Authored-By: Qiu Fossen <qiujunting> Part of blueprint add-user-id-field-to-the-migrations-table Change-Id: I7313d6cde1a5e1dc7dd6f3c0dff9f30bbf4bee2c
* | | api-ref: Fix security groups parametersTakashi NATSUME2019-10-072-5/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The security groups parameters are optional in the response of the following APIs. - GET /servers/detail - GET /servers/{server_id} - PUT /servers/{server_id} - POST /servers/{server_id}/action (rebuild) So fix them. Change-Id: Icc2315fd8b8c085de9d560de6ddf4c05aaaf6acb Closes-Bug: #1846656
* | | api-ref: fix server topology "host_numa_node" field param nameMatt Riedemann2019-09-062-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | The actual parameter in the response of the API is "host_node" without "numa" in it so this fixes the docs to match the code and sample. Change-Id: Ie562d47e0fa7414bcdccf407b79e71e1aae8d708 Closes-Bug: #1843098
* | | Add delete_on_termination to volume-attach APIzhangbailin2019-09-052-6/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the 'delete_on_termination' field to the volume attach API to support configuring whether to delete the data volume when the instance is destroyed. To avoid upgrade impact issues with older computes, the 'delete_on_termination' field is set in the API rather than when the BDM is created in the compute service. Implements: blueprint support-delete-on-termination-in-server-attach-volume Change-Id: I55731b1822a4e32909665a2872d80895cb5b12f7
* | | Add server sub-resource topology APIYongli He2019-08-303-0/+124
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a new server topology API to show server NUMA information: - GET /servers/{server_id}/topology Add new policy to control the default behavior: - compute:server:topology:index - compute:server:topology:host:index Change-Id: Ie647ef96597195b0ef00f77cece16c2bef8a78d4 Implements: blueprint show-server-numa-topology Signed-off-by: Yongli He <yongli.he@intel.com>
* | | Specify availability_zone to unshelvezhangbailin2019-08-272-1/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds support, in a new microversion, for specifying an availability zone to the unshelve server action when the server is shelved offloaded. Note that the functional test changes are due to those tests using the "latest" microversion where an empty dict is not allowed for unshelve with 2.77 so the value is changed from an empty dict to None. Implements: blueprint support-specifying-az-when-restore-shelved-server Closes-Bug: #1723880 Change-Id: I4b13483eef42bed91d69eabf1f30762d6866f957
* | | Update api-ref for 2.75 to add config_drive in server update responseGhanshyam Mann2019-08-203-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In 2.75, we missed to add the config_drive field in api-ref for update server response - I9d257a003d315b84b937dcef91f3cb41f3e24b53. This commit updates the api-ref. Change-Id: I46ab0b8650bf50a5384bb56027cdf0dc2a9bb2fe Partial-Implements: blueprint api-consistency-cleanup
* | | api-ref: add config_drive to 2.75 rebuild response parametersMatt Riedemann2019-08-192-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | Change I9d257a003d315b84b937dcef91f3cb41f3e24b53 and the 2.75 microversion returns the config_drive parameter in the rebuild response and it's in the 2.75 rebuild response sample but was missing from the response parameters table. Change-Id: I89eca8638bc0d64b7f320f4ec5c49375bfebdb56
* | | Merge "API microversion 2.76: Add 'power-update' external event"Zuul2019-08-152-7/+19
|\ \ \
| * | | API microversion 2.76: Add 'power-update' external eventSurya Seetharaman2019-08-152-7/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch adds a new external event called "power-update" through which ironic will convey all (power_off and power_on) power state changes (running -> shutdown or shutdown -> running will be the only ones handled by nova and the rest will be ignored) on a physical instance to nova. The database will be updated accordingly to reflect the real vm_state and power_state of the instance. This way nova will not be able to enforce an incorrect power state on the physical instance during the periodic "sync_power_states" task. Implements blueprint nova-support-instance-power-update Story: 2004969 Task: 29423 Change-Id: I2b292050cc3ce5ef625659f5a1fe56bb76072496
* | | | api-ref: Fix collapse of 'host_status' descriptionTakashi NATSUME2019-08-141-0/+2
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix collapse of 'host_status' description in the follwoing APIs in the compute API reference. - PUT /servers/{server_id} - POST /servers/{server_id}/action (rebuild) Change-Id: I003f9a81ac6f7e0ec13a24db3fda1b7ff6612bc5 Closes-Bug: #1840094
* | | Multiple API cleanup changesGhanshyam Mann2019-08-124-17/+277
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This microversion implements below API cleanups: 1. 400 for unknown param for query param and for request body. 2. Making server representation always consistent among all APIs returning the complete server representation. 3. Change the default return value of ``swap`` field from the empty string to 0 (integer) in flavor APIs. 4. Return ``servers`` field always in the response of GET hypervisors API even there are no servers on hypervisor Details: https://specs.openstack.org/openstack/nova-specs/specs/train/approved/api-consistency-cleanup.html Partial-Implements: blueprint api-consistency-cleanup Change-Id: I9d257a003d315b84b937dcef91f3cb41f3e24b53
* | | Merge "Retrun 400 if invalid query parameters are specified"Zuul2019-08-091-1/+17
|\ \ \
| * | | Retrun 400 if invalid query parameters are specifiedTakashi NATSUME2019-08-041-1/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The following APIs return 500 error currently if an invalid sort key or an invalid sort direction query parameter is specified. - GET /flavors - GET /flavors/detail Make the APIs return 400 error in that case. Change-Id: I1d6d2c1f734b28dbea5c67cf88717149dd4911d7 Closes-Bug: #1835925
* | | | api-ref: document valid GET /os-migrations?migration_type valuesMatt Riedemann2019-08-061-1/+6
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are only four valid values for the migration_type filter when listing migrations so let's document them for the request parameter. Note that the API jsonschema validation does not restrict the values since the filter parameter pre-dated jsonschema validation for query parameters. Specifying an invalid value would just result in no results from the DB query. Change-Id: I7fee254edefd524633af62d80cb47009b1cf010b
* | | Merge "api-ref: touch up the os-services docs"Zuul2019-07-251-3/+4
|\ \ \
| * | | api-ref: touch up the os-services docsMatt Riedemann2019-07-251-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Make it clear that the first GET /os-services response sample is for 2.11 and make the version suffix format for the 2.69 example match the other response examples, i.e. "(v2.x)". Also mention that PUT /os-services/{service_id} only allows nova-compute services. Before Pike it was possible to update non-nova-compute services though it didn't really make sense. Change-Id: I585582710884a53d91f4453011d3407a94efe1e3
* | | | Merge "Correct project/user id descriptions for os-instance-actions"Zuul2019-07-253-7/+19
|\ \ \ \ | |/ / / |/| | |
| * | | Correct project/user id descriptions for os-instance-actionsqiufossen2019-07-223-7/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The 'user_id' and 'project_id' parameter descriptions for server actions imply that they are the value of the user/project that owns the server, but that is incorrect - they are the project/user id of whoever made the request/initiated the action. The existing project_id_instance_action parameter variable, which is only used by the os-cloudpipe reference, is renamed to avoid confusion with instance actions. Co-Authored-By: Brin Zhang <zhangbailin@inspur.com> Closes-Bug: #1835063 Change-Id: I1c05d59ebf1fda6319df5ee305c2b8a6a9562242
* | | | Merge "Remove deprecated Core/Ram/DiskFilter"Zuul2019-07-231-2/+4
|\ \ \ \
| * | | | Remove deprecated Core/Ram/DiskFilterStephen Finucane2019-07-231-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These were deprecated during Stein [1] and can now be removed, lest they cause hassle with the PCPU work. As noted in [1], the aggregate equivalents of same are left untouched for now. [1] https://review.opendev.org/#/c/596502/ Change-Id: I8a0d332877fbb9794700081e7954f2501b7e7c09 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | | | Update api-ref locationAndreas Jaeger2019-07-2216-38/+38
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | Bump the openstackdocstheme extension to 1.20zhangyangyang2019-07-191-16/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I3a5c7e115d0c4f52b015d0d55eb09c9836cd2fe7
* | | | Merge "Remove needs:* todo from deprecated APIs api-ref"Zuul2019-07-135-16/+10
|\ \ \ \
| * | | | Remove needs:* todo from deprecated APIs api-refGhanshyam Mann2019-06-285-16/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are few needs:body/example/parameter_verification pending on deprecated APIs. It is not worth to spend time on completing those. Removing those todo part and adding note about not updating them. Change-Id: I1f2bc4e6d8bdb2b41c4b22c18573a4fc75bea38e
* | | | | Add host and hypervisor_hostname flag to create serverzhu.boxiang2019-07-092-0/+27
| |/ / / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a new microversion that adds two new params to create server named 'host' and 'hypervisor_hostname'. Part of Blueprint: add-host-and-hypervisor-hostname-flag-to-create-server Change-Id: I3afea20edaf738da253ede44b4a07414ededafd6
* | | | api-ref: Fix a broken linkTakashi NATSUME2019-07-051-3/+0
|/ / / | | | | | | | | | | | | | | | | | | | | | The link to the API extension document has been broken. The API extension document does not exist currently, so just remove the link. Change-Id: I8920a00004528f5fa30d1b5a2f53ffa5f65f2ea8
* | | conf: Rename 'configuration drive' to 'config drive'Stephen Finucane2019-06-202-2/+2
| |/ |/| | | | | | | | | | | Keeps dansmith happy. Change-Id: Ifd8537692de98ee02ff7333812d2877273a0a388 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Block swap volume on volumes with >1 rw attachment"Zuul2019-05-301-0/+3
|\ \
| * | Block swap volume on volumes with >1 rw attachmentMatt Riedemann2019-05-221-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If we're swapping from a multiattach volume that has more than one read/write attachment, another server on the secondary attachment could be writing to the volume which is not getting copied into the volume to which we're swapping, so we could have data loss during the swap. This change does volume read/write attachment counting for the volume we're swapping from and if there is more than one read/write attachment on the volume, the swap volume operation fails with a 400 BadRequest error. Depends-On: https://review.openstack.org/573025/ Closes-Bug: #1775418 Change-Id: Icd7fcb87a09c35a13e4e14235feb30a289d22778
* | | Fix the server group "policy" field type in api-refYikun Jiang2019-05-291-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The server group policy field added in v2.64 is a string but the API reference says the parameter is an object. This patch changes it from "object" to "string". Change-Id: I1b4efe8afb302d94c810389e124c5370cbe72ddf Closes-bug: #1830800
* | | Merge "Update description of valid whitelist for non-admin user"Zuul2019-05-231-1/+3
|\ \ \ | |/ / |/| |
| * | Update description of valid whitelist for non-admin user翟小君2019-05-221-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Non-admin user can filter instance by instance-uuid and other filter keys with being configured using the "os_compute_api: servers:allow_all_filters" policy rule. The policy rule was added with Ia5504da9a00bad689766aeda20255e10b7629f63. Closes-Bug:1819425 Change-Id: I74146b4370b6017cb199466258165fc6df080082
* | | api-ref: mention default project filtering when listing serversMatt Riedemann2019-05-171-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This removes the "all" wording from the List Servers API reference docs since it could be confused with actually returning all servers across all tenants (the all_tenants filters). It also mentions that by default only servers associated with the project making the request are returned, i.e. the project associated with the auth token on the request. This is probably fairly obvious and automatic to anyone that's worked with openstack for a long time but might not be for a new user and is not really documented anywhere in the API reference or API guide that I could find. Change-Id: Ie28164e4813a7a48addcd80d81c72c978ac9f395
View Lorry Controller Status