summaryrefslogtreecommitdiff
path: root/api-ref
Commit message (Collapse)AuthorAgeFilesLines
* Microversion 2.94: FQDN in hostnameArtom Lifshitz2023-01-173-0/+13
| | | | | | | | | | | | | Extend microversion 2.90 to allow FQDNs in the hostname parameter. Multi-create with --hostname continues to be refused, returning error 400 to the user. This simplifies the code by not needing to handle any sort of suffix or prefix mangling of the FQDN to handle multiple instances. No other changes are made - not Neutron integration, metadata API changes (the FQDN will appear as-is in places where the hostname currently appears), etc. Change-Id: I47e397dc6da8263762479cc8ae4f8777a6d9d811 Implements: bp/fqdn-in-hostname
* Doc: Fix list servers detailed response paramPatrick Hampson2022-10-281-1/+1
| | | | Change-Id: If94895d0fc4b5a59febd02e127fbf93959084fee
* Updated flavors docAmit Uniyal2022-09-172-2/+12
| | | | | | | Flavor with special characters in flavor ID is not allowed to create Closes-Bug: 1920938 Change-Id: I600ae07f7fb039c9ccf461c4bf74ae42d9a3744f
* Add API support for rebuilding BFV instancesDan Smith2022-08-312-11/+20
| | | | | | | | | | | | | This adds a microversion and API support for triggering a rebuild of volume-backed instances by leveraging cinder functionality to do so. Implements: blueprint volume-backed-server-rebuild Closes-Bug: #1482040 Co-Authored-By: Rajat Dhasmana <rajatdhasmana@gmail.com> Change-Id: I211ad6b8aa7856eb94bfd40e4fdb7376a7f5c358
* api: Drop generating a keypair and add special chars to namingSylvain Bauza2022-07-282-7/+35
| | | | | | | | | | | | | | | As agreed in the spec, we will both drop the generation support for a keypair but we'll also accept @ (at) and . (dot) chars in the keyname, all of them in the same API microversion. Rebased the work from I5de15935e83823afa545a250cf84f6a7a37036b4 APIImpact Implements: blueprint keypair-generation-removal Co-Authored-By: Nicolas Parquet <nicolas.parquet@gandi.net> Change-Id: I6a7c71fb4385348c87067543d0454f302907395e
* Allow unshelve to a specific host (REST API part)René Ribaud2022-07-222-5/+105
| | | | | | | | | | | | | | This adds support to the REST API, in a new microversion, for specifying a destination host to unshelve server action when the server is shelved offloaded. This patch also supports the ability to unpin the availability_zone of an instance that is bound to it. Note that the functional test changes are due to those tests using the "latest" microversion 2.91. Implements: blueprint unshelve-to-host Change-Id: I9e95428c208582741e6cd99bd3260d6742fcc6b7
* api-ref: Adjust BFV rescue non-support note.Artom Lifshitz2021-11-221-1/+2
| | | | | | Rescuing BFV instances became a thing in 2.87. Fix our api-ref. Change-Id: I9c4fbea53b05490cf05ebd311b25791fa191af16
* Merge "Add some missing parameters in docs of os-cells"Zuul2021-09-011-0/+14
|\
| * Add some missing parameters in docs of os-cellsbudebao2021-08-251-0/+14
| | | | | | | | Change-Id: I48c68e135bdfa7229eac6b242b7f80b005761ee8
* | api: Add support for 'hostname' parameterStephen Finucane2021-01-143-31/+66
| | | | | | | | | | | | | | | | | | Add microversion 2.90, which allows allows users to configure the hostname that will be exposed via the nova metadata service when creating their instance. Change-Id: I95047c1689ac14fa73eba48e19dc438988b78aad Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Merge "fup: Fix os-volume_attachments api-ref parameters"Zuul2021-08-251-4/+4
|\ \ | |/ |/|
| * fup: Fix os-volume_attachments api-ref parametersLee Yarwood2021-08-241-4/+4
| | | | | | | | Change-Id: Ibf5ca2969065262f4aa14b3764af74af37d88408
* | Merge "api: Introduce microversion 2.89 adjusting os-volume_attachments"Zuul2021-08-242-13/+32
|\ \ | |/
| * api: Introduce microversion 2.89 adjusting os-volume_attachmentsLee Yarwood2021-08-242-13/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This microversion adds attachment_id and bdm_uuid as stored in the underlying bdm record while also removing the duplicate id field from the responses of ``GET /servers/{server_id}/os-volume_attachments`` and ``GET /servers/{server_id}/os-volume_attachments/{volume_id}``. To accomidate this within the _translate_attachment_summary_view helper is folded into _translate_attachment_detail_view with the remaining caller in the now deprecated os-volumes API now replaced with a static dictionary. Blueprint: add-attachmentid-to-responses-of-the-os-volume-attachments-api Change-Id: I977c3fd9bbb1e1d42e6979222137e7366d2815e8
* | docs: Drop references to non-filter scheduler driversStephen Finucane2021-08-231-1/+1
|/ | | | | | | | Take the opportunity to clean up the docs quite a bit, ultimately combining two disparate guides on the scheduler into one. Change-Id: Ia72d39b4774d93793b381359b554c717dc9a6994 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* trivial: fix word duplication in api refBalazs Gibizer2021-03-221-2/+2
| | | | | Change-Id: I3878fb9f36bb05dbb949f137a5d5c6664a27b69f Closes-Bug: #1920256
* Merge "api-ref: Add notes about volume attach and detach being async"Zuul2021-01-201-0/+9
|\
| * api-ref: Add notes about volume attach and detach being asyncLee Yarwood2020-12-211-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change adds some basic notes in the api-ref for a wrinkle in the current os-volume_attachments API in that both attach and detach actions are async, returning to the caller *before* the underlying action is complete. As such callers need to make seperate calls to ensure these actions complete successfully. There are also currently two different ways of polling for completion when attaching and detaching. - When attaching callers should use the volume status and list of attachments as reported by the volume API. - When detaching callers should instead use the list of volume attachments reported by the os-volume_attachments API. This is due to the way in which Nova currently completes the attachment via c-api last during attachment and deletes the bdm record last during detachment. It would be useful to one day centralise on just using the os-volume_attachments API to poll both actions but to do that we would need to start tracking our own state within the BDMs. Change-Id: Id367ee53ef1458b6a90fc107ab14f5b3cbba7a86
* | api-ref: Clarify 'all_tenants' commandStephen Finucane2021-01-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | An empty value for the 'all_tenants' query parameter of '/servers' and '/servers/detail' means the value defaults to 'True', i.e. requesting '/servers?all_tenants' is the same as '/servers?all_tenants=1'. Clarify this, since the current wording is confusing. Change-Id: Ib5fdd3b73aa5179e0379ee8f465e4118107786be Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Closes-Bug: #1909745
* | api: Drop statistics-style fields from os-hypervisorsStephen Finucane2021-01-082-28/+90
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Introduce API microversion 2.88, which makes the following changes to a number of 'os-hypervisors'. Specifically, the following fields are dropped from both the '/os-hypervisors/detail' (detailed list) and '/os-hypervisors/{hypervisor_id}' (show) APIs: - current_workload - cpu_info - vcpus - vcpus_used - free_disk_gb - local_gb - local_gb_used - disk_available_least - free_ram_mb - memory_mb - memory_mb_used - running_vms In addition, the '/os-hypervisors/statistics' API, which provided a summary of the above stats but for all hypervisors in the deployment, is dropped entirely. Finally, the '/os-hypervisors/{hypervisor}/uptime' API, which provided a similar response to the '/os-hypervisors/{hypervisor}' API but with an additional 'uptime' field, has been removed in favour of including this field in the primary '/os-hypervisors/{hypervisor}' API. A small tweak to 'tox.ini' that allows us to share some venvs is included. Part of blueprint modernize-os-hypervisors-api Change-Id: I515e484ade6c6455f82a3067940a418a0d7d965a Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Improving the description for unshelve request bodyzhangbailin2021-01-051-0/+4
|/ | | | | | | | | | | | The 'availability_zone' description in unshelve api-ref is confusing, adding NOTE for unshelve request body: Since microversion 2.77, allowed request body schema are {"unshelve": null} or {"unshelve": {"availability_zone": <string>}}. A request body of {"unshelve":{}} is not allowed. Closes-Bug: #1908336 Change-Id: I66c209baf11c37ffebca52764263daae9e1dd50b
* Enhance simple usage API documentationRafael Weingärtner2020-12-071-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Nova's `os-simple-tenant-usage` has the following statement. ``` Reports usage statistics of compute and storage resources periodically for an individual tenant or all tenants. The usage statistics will include all instances’ CPU, memory and local disk during a specific period. ``` To some people, when reading that, they might get the understanding that the `os-simple-tenant-usage` will report the actual use of resources. Therefore, if a VM is stopped and then started back again, it (the `os-simple-tenant-usage`) would only report the time the VM has been up and running. However, that is not what happens. The `os-simple-tenant-usage` reports the time that a virtual machine (VM) exists in the cloud environment. Therefore, actions such as pause, suspend, and stop do not affect the usage accounting. This might be a problem for people using this API for billing, or for people that use other systems (e.g. CloudKitty) for billing. End-users might try to cross-check the data from the billing from CloudKitty for instance, with the usage report found in Horizon that uses this API, and the numbers will not add up, as people might only consider the time a VM has been up and running to charge users in CloudKitty. An extension was proposed in [1], to allow operators to customize the usage accounting. However, during a meeting with the community [2], the extension was rejected for two reasons: * Nova tries to avoid using config driven APIs. Meaning, APIs that change the response according to server-side configurations; * The community has decided to get rid of usage and billing accounting in Nova. Having said that, we would like to propose a documentation amendment. The idea is to explicitly say for users/operators that the simple usage API only considers the time that the VM existed in the cloud for the accounting, and not the actual time it has been up and running. This will save some misunderstanding and misuse of the API data. References =========== [1] https://review.opendev.org/c/openstack/nova/+/711113 [2] http://eavesdrop.openstack.org/meetings/nova/2020/nova.2020-12-03-16.00.log.txt Closes-Bug: #1907133 Change-Id: Ic55669f5210b57f151f693393f205655765a8dc9
* virt: Remove 'reset_network' APIStephen Finucane2020-11-231-5/+8
| | | | | | | | | This one is tied into an admin action in the server actions API, which means we must remove that API action also. Otherwise, this isn't too crazy. Change-Id: I58343b94b67915062d044fa0f53aeab01b77738f Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* api-ref: Move 'os-agents' API to obsolete sectionStephen Finucane2020-11-171-1/+1
| | | | | | | Follow up for change I9512f605dd2b3b0e88c951ed086250d57056303d. Change-Id: Ia627bab8ed911baf329e0bda385beb2ffcbbe7d6 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* api: Remove 'os-agents' APIStephen Finucane2020-09-111-4/+13
| | | | | | | This was only useful with XenAPI and can therefore be removed. Change-Id: I9512f605dd2b3b0e88c951ed086250d57056303d Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* trivial: Final cleanupStephen Finucane2020-09-111-2/+1
| | | | | | | | Remove references to the feature from various comments scattered throughout the code. Change-Id: Ic353a2489389c557859c249218eaf6060974e1a9 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* compute: Validate a BDMs disk_bus when providedLee Yarwood2020-07-291-3/+4
| | | | | | | | | | | | | | | | Previously disk_bus values were never validated and could easily end up being ignored by the underlying virt driver and hypervisor. For example, a common mistake made by users is to request a virtio-scsi disk_bus when using the libvirt virt driver. This however isn't a valid bus and is ignored, defaulting back to the virtio (virtio-blk) bus. This change adds a simple validation in the compute API using the potential disk_bus values provided by the DiskBus field class as used when validating the hw_*_bus image properties. Closes-Bug: #1876301 Change-Id: I77b28b9cc8f99b159f628f4655d85ff305a71db8
* Fix pygments_styleAndreas Jaeger2020-05-201-1/+1
| | | | | | | | Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Change-Id: Icd9d529dbe66626ac53a9fdca5bc6821998a0b7d
* Merge "Switch to newer openstackdocstheme and reno versions"Zuul2020-05-161-3/+3
|\
| * Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-151-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.1.2 and reno 3.1.0 versions. Using these versions will allow parallelizing building of documents. Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_version to not version the documents. Set openstackdocs_auto_name to use project as name. Depends-On: https://review.opendev.org/728432 Change-Id: I4e3ae3ceabe125ea459ed4baabf2e98686268e50
* | docs: Add evacuation pre-conditions around the src hostLee Yarwood2020-05-061-0/+6
|/ | | | | | | These were previously not listed but are important to re-enforce to avoid corruption of instances during an evacuation. Change-Id: Ia80dba0ade98940a5c4f94a9d2095e3c9ef21f97
* [Trivial] FUP: addressed comments in support non-admin filter instanceszhangbailin2020-04-101-33/+33
| | | | | | | | | This commit mainly addressed comments in [1] [1]https://review.opendev.org/#/c/701609/9/api-ref/source/parameters.yaml@420 that were related to change Ia66d3a1ceb74ed521cf44922929b2a502f3ee935 Part of blueprint non-admin-filter-instance-by-az Change-Id: I8627de0fdb31f2090a4eef7dba8f0f5eb4ebb946
* Allow PUT volume attachments API to modify delete_on_terminationzhangbailin2020-04-022-13/+65
| | | | | | | | | | | | | | | | Allow PUT /servers/{server_id}/os-volume_attachments/{volume_id}`` to support specifying ``delete_on_termination`` field in the request body. This allows updating the attached volume's flag that controls whether or not it is automatically deleted when the instance is deleted. When we request 'volumeId' and 'delete_on_termination' in the requst body to swap volume, since the new microversion it will be support updating the swapping volume's delete flag. Co-Authored-By: Dan Smith <dansmith@redhat.com> Blueprint: destroy-instance-with-datavolume Change-Id: I6ccac4e17f56b40e67c79d40f32558ef414685ea
* Add instance actions v284 samples testzhangbailin2020-03-302-0/+13
| | | | | Implements blueprint action-event-fault-details Change-Id: I8e8a5ca1efe4a3554038dcddc503c3030956e0b9
* Merge "Non-Admin user can filter their instances by more filters"Zuul2020-03-262-23/+44
|\
| * Non-Admin user can filter their instances by more filtersVictor Coutellier2020-03-152-23/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Microversion bump to allow non-admin user to use more filters key when listing instances. In order to stay coherent, all existing instance filters who are related to a field readable by default to non admin users when showing instance details, should be allowed by default without policy modification. Implements: blueprint non-admin-filter-instance-by-az Change-Id: Ia66d3a1ceb74ed521cf44922929b2a502f3ee935
* | trivial: Rename directory for os-keypairs samplesStephen Finucane2020-03-061-4/+4
|/ | | | | | | | We have a custom of naming the directory after the API. Reinforce that here. Change-Id: I5bf68aacc1d987400a91467835c4b55f03c18beb Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Merge "api-ref: mark device response param as optional for list/show vol ↵Zuul2020-03-031-2/+2
|\ | | | | | | attachments"
| * api-ref: mark device response param as optional for list/show vol attachmentsMatt Riedemann2019-11-131-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The 'device' response parameter is not included in GET /servers/{server_id}/os-volume_attachments or GET /servers/{server_id}/os-volume_attachments/{volume_id} when the BDM doesn't have a device_name set, which can be the case with a volume attached to a shelved offloaded server. Also, see the logic in _translate_attachment_detail_view and _translate_attachment_summary_view. This simply marks the response parameter as optional in those APIs. Since the parameter is optional, it is sorted to after the required parameters but before the parameters added in new microversions. Change-Id: Ifda2f7983f349d51d97e5621cac6c5ad9cb0295f Closes-Bug: #1818345
* | Define Cyborg ARQ binding notification event.Sundar Nadathur2020-03-011-0/+3
| | | | | | | | | | | | | | | | APIImpact: Adds 2.82 microversion for /os-server-external-events API. DocImpact: Adds new version to doc/api_samples/versions/. Change-Id: I7a626544d8221dc0eeb5672986ca897ce4718be8 Blueprint: nova-cyborg-interaction
* | Merge "Follow-up: Add delete_on_termination to volume-attach API"Zuul2020-02-201-4/+4
|\ \
| * | Follow-up: Add delete_on_termination to volume-attach APIzhangbailin2020-02-191-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some comment mainly from gmann and takashin in [1] PS15. Add some tests in test_volumes.py, and fix some docs error. [1]https://review.opendev.org/#/c/673133/15/nova/tests/unit/api/openstack/compute/test_volumes.py@1902 Depends-On: https://review.opendev.org/#/c/673133/ Part of blueprint support-delete-on-termination-in-server-attach-volume Change-Id: I8dfa61f03ce927a1e86d42f8fb03bf4cb3e48160
* | | nova-net: Update API reference guideStephen Finucane2020-01-223-7/+13
|/ / | | | | | | | | | | | | | | | | | | As highlighted in I77b1cfeab3c00c6c3d7743ba51e12414806b71d2, filtering either floating IPs or floating IP pools by floating IP name will actually fallback to filtering by ID. Update the API ref to reflect this. Change-Id: I00443ae111cbd1e1ec4d2c2ae1828ddaa095fd1a Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Remove 'nova-xvpvncproxy'"Zuul2020-01-083-8/+3
|\ \
| * | Remove 'nova-xvpvncproxy'Stephen Finucane2019-12-233-8/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This legacy service is no longer used and was deprecated during the Stein cycle [1]. It's time to say adios and remove them in their entirety. This is pretty straightforward, with the sole exception of schema for the 'remote-consoles' API, which has to continue supporting requests for type 'xvpvnc' even if we can't fulfil those requests now. [1] https://review.opendev.org/#/c/610076/ Part of blueprint remove-xvpvncproxy Depends-On: https://review.opendev.org/695853 Change-Id: I2f7f2379d0cd54e4d0a91008ddb44858cfc5a4cf Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | [api-ref] Fix the incorrect linkchenxing2019-12-241-8/+8
|/ / | | | | | | | | | | | | | | | | | | | | This page[1] doesn't talk about paging or servers_links. The API reference description should link here[2] for talking about paging. [1]https://docs.openstack.org/api-guide/compute/links_and_references.html [2]https://docs.openstack.org/api-guide/compute/paginated_collections.html Change-Id: I4831d5c2b9598e37346f1e65135b11446b2458eb Closes-Bug: #1856241
* | api-ref: avoid mushy wording around server.image descriptionMatt Riedemann2019-12-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | This disambiguates the description on the server.image parameter. If the server is booted from volume (where boot from volume means there is a bdm with boot_index=0 and destination_type=volume), then the server.image will be an empty string [1] otherwise it will be a dict. [1] https://github.com/openstack/nova/blob/2f0f8b8cf13b7441ce6a7a524b33d30d40f1d468/nova/api/openstack/compute/views/servers.py#L540 Change-Id: Ia1ecd39a5636fa5a35cdbcafc03828b2925a9033
* | Keep pre-commit inline with hacking and fix whitespaceMonty Taylor2019-12-123-13/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The flake8 hook for pre-commit installs its own flake8 which is not what hacking is pinned to. This results in a bunch of errors. By doing a local hook we can cause these to be the same. There are flake8 exclusions in tox.ini that need to be used in pre-commit. Also we should exclude svg files from the whitespace modifications, because who cares. Once those are fixed, running pre-commit -a fixes some whitespace issues. While the normal use isn't to run -a - if someone does make a patch that touches any of these they'll get erroneous unrelated errors compared to their lower work - so fix all of the existing issues, which are mostly space-at-end-of-line issues it seems. Change-Id: I78e753492e99c03b30a0a691db3bd75ee3d289c9
* | Nix os-server-external-events 404 conditionEric Fried2019-12-091-3/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The POST /os-server-external-events API had the following confusing behavior: With multiple events in the payload, if *some* (but not all) were dropped, the HTTP response was 207, with per-event 4xx error codes in the payload. But if *all* of the events were dropped, the overall HTTP response was 404 with no payload. Thus, especially for consumers sending only one event at a time, it was impossible to distinguish e.g. "you tried to send an event for a nonexistent instance" from "the instance you specified hasn't landed on a host yet". This fix gets rid of that sweeping 404 condition, so if *any* subset of the events are dropped (including *all* of them), the HTTP response will always be 207, and the payload will always contain granular per-event error codes. This effectively means the API can no longer return 404, ever. Closes-Bug: #1855752 Change-Id: Ibad1b51e2cf50d00102295039b6e82bc00bec058
* | Merge "Remove 'os-consoles' API"Zuul2019-11-224-65/+68
|\ \
View Lorry Controller Status