openstack/nova - nova - OpenDev: Free Software Needs Free Tools

Add sample API content This adds sample API content for versions and servers resources, including the parameters.yaml that is needed in both of these cases. It also makes a new tox.ini target 'api-ref' for building these docs, which will be used as part of the publishing pipeline. Change-Id: I310ed352dc5dd81d01f2fd5f1a2fab662c29f0dc

2016年03月29日 11:56:21 -04:00

:tocdepth: 2

=============

Compute API

=============

Add 'Show All' / 'Hide All' toggle This adds a global control that does show / hide of all collapseable sections. Which is extremely useful in seeing the entire API at once. Part of bp:api-ref-in-rst Change-Id: I814e6b2c20c25bf3d4cb4e722bc8157ca0aa1b89

2016年04月14日 07:34:15 -04:00

Replace "Openstack" with "OpenStack" According to the word choice convention in http://docs.openstack.org/contributor-guide/writing-style/word-choice.html We should use "OpenStack" instead of "Openstack". Change-Id: Ie55354adb17fb3617995cf9463e670e4788723ca

2016年12月22日 23:15:37 +08:00

This is a reference for the OpenStack Compute API which is provided by the Nova

project. To learn more about the OpenStack Compute API concepts, please refer to

Update api-ref location 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

2019年07月22日 18:08:40 +02:00

the `API guide <https://docs.openstack.org/api-guide/compute/index.html>`_.

Add link ref to nova api concept doc This patch adds link to the api concept doc. Change-Id: I3c9f7ebce7f4241a41492511b39f8649190b53eb Partial-implements: blueprint api-ref-in-rst-ocata

2016年09月19日 10:35:14 +08:00

Add 'Show All' / 'Hide All' toggle This adds a global control that does show / hide of all collapseable sections. Which is extremely useful in seeing the entire API at once. Part of bp:api-ref-in-rst Change-Id: I814e6b2c20c25bf3d4cb4e722bc8157ca0aa1b89

2016年04月14日 07:34:15 -04:00

.. rest_expand_all::

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: versions.inc

remove /v2.1/{tenant_id} from all urls 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

2016年06月02日 08:50:03 -04:00

.. include:: urls.inc

api-ref: Add X-Openstack-Request-Id description Add the description for the following items in the API reference and the API guide. * 'X-Openstack-Request-Id' header in request * 'X-Openstack-Request-Id' header in response * 'X-Compute-Request-Id' in response Change-Id: Idd9181c1530eb9576da9941416b697a97c0cfb8d Closes-Bug: #1693555

2017年06月16日 11:38:55 +09:00

.. include:: request-ids.inc

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: servers.inc

.. include:: servers-actions.inc

.. include:: servers-action-fixed-ip.inc

.. include:: servers-action-deferred-delete.inc

.. include:: servers-action-console-output.inc

.. include:: servers-action-shelve.inc

.. include:: servers-action-crash-dump.inc

api-ref: Complete all the verifications of remote consoles This patch includes all the verifications of remote consoles part of blueprint api-ref-in-rst-pike Co-Authored-By: Markus Zoeller <mzoeller@linux.vnet.ibm.com> Change-Id: Ib169e4bd931b5a04f31cd0e7c43c161b49eafe5c

2016年07月06日 14:35:08 +08:00

.. include:: servers-action-remote-consoles.inc

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: servers-admin-action.inc

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:00:00 +09:00

.. include:: servers-action-evacuate.inc

api-ref: Complete all the verifications of remote consoles This patch includes all the verifications of remote consoles part of blueprint api-ref-in-rst-pike Co-Authored-By: Markus Zoeller <mzoeller@linux.vnet.ibm.com> Change-Id: Ib169e4bd931b5a04f31cd0e7c43c161b49eafe5c

2016年07月06日 14:35:08 +08:00

.. include:: servers-remote-consoles.inc

Separate api-ref for list security groups by server All proxy APIs are now deprecated which includes sec grp APIs also. But list sec grps by server API- (/servers/{server_id}/os-security-groups) is not deprecated so this should be separated from deprecated sec grp APIs in api-ref. Partially implements blueprint deprecate-api-proxies Change-Id: I9f9e2cf5f8e390cecd9e1794a0af1a3fcc24f149

2016年07月21日 16:42:57 +09:00

.. include:: server-security-groups.inc

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: diagnostics.inc

.. include:: ips.inc

.. include:: metadata.inc

.. include:: os-instance-actions.inc

.. include:: os-interface.inc

.. include:: os-server-password.inc

.. include:: os-volume-attachments.inc

.. include:: flavors.inc

.. include:: os-flavor-access.inc

.. include:: os-flavor-extra-specs.inc

.. include:: os-keypairs.inc

.. include:: limits.inc

.. include:: os-aggregates.inc

.. include:: os-assisted-volume-snapshots.inc

.. include:: os-availability-zone.inc

.. include:: os-hypervisors.inc

.. include:: os-instance-usage-audit-log.inc

.. include:: os-migrations.inc

api-ref: method verification for server-migrations We don't have any api-ref for server-migrations. os-migrations is frozen and server-migrations replaces it, but we don't have any docs for it, so this is a start. Partial-Bug: #1641713 Part of blueprint api-ref-in-rst-ocata Change-Id: I3da6ff6a4a0abf2f9c8bae3fb28fe23fdc3b0959

2016年11月14日 16:12:29 -05:00

.. include:: server-migrations.inc

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: os-quota-sets.inc

Add api-ref for os-quota-class-set APIs This commit adds the api doc for os-quota-class-set GET & PUT APIs. - Also mentioned about the recommendation over usage of this API. - Added warning for current bug in v2.1 API #1693168 This is also needed by BP - https://blueprints.launchpad.net/nova/+spec/fix-quota-classes-api Change-Id: Ib765e2d1dec7b236a2009148e0b1067a46326ce9 Related-Bug: #1693168 Closes-Bug: #1602400

2017年05月25日 12:06:11 +03:00

.. include:: os-quota-class-sets.inc

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: os-server-groups.inc

api-ref: added docs for microversion 2.26 Part of bp:tag-instances Part of bp:api-ref-in-rst Change-Id: Ifd0d518d086719eb248b442359c272b1799544c6

2016年06月08日 16:16:45 +03:00

.. include:: os-server-tags.inc

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. include:: os-services.inc

.. include:: os-simple-tenant-usage.inc

api-ref: finish validation for os-server-external-events.inc This completes the validation for the admin event interface, including detailing the codes we currently return in the parameter list. Because os-service was incorrectly using the 'status' key, when I renamed status => event_status I needed to also create a service_status to make things compile. It's accurate enough to move forward. Because this is really a Neutron only API, this is moved towards the bottom of the API list, to make it clear this isn't really designed to be used by end user apps. Part of bp:api-ref-in-rst Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56

2016年05月11日 14:47:13 -04:00

.. include:: os-server-external-events.inc

Add server sub-resource topology API 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>

2019年02月26日 06:57:52 +08:00

.. include:: server-topology.inc

api-ref: mark os-cells as deprecated As part of an effort to scrub the nova docs of cells v1 references [1] this moves the os-cells API reference to be grouped with the other deprecated APIs. A section title is added, similar to the "Obsolete APIs" section, for organizational purposes. It should be noted that the os-cells APIs have not been formally deprecated by capping them at some maximum microversion like the other deprecated proxy APIs or for the nova-network APIs, but cells v1 was deprecated in Pike [2] and since the os-cells APIs are admin-only, they can be considered effectively deprecated with the cells v1 deprecation itself, and when we delete the cells v1 service code the APIs will also be gone like the other Obsolete APIs. [1] http://lists.openstack.org/pipermail/openstack-discuss/2019-February/002569.html [2] I1a173f7ce0715e684850e030c358e8175fa8724c Change-Id: I833d2e8d8857448c2922df488ae9d9b425050ddc

2019年02月13日 13:19:06 -05:00

===============

Deprecated APIs

===============

This section contains references for APIs which are deprecated and usually

limited to some maximum microversion.

Deprecated the concept of extensions in v2.1. The extensions in api-ref-compute-v2.1 is deprecated. This patch depricates the extension infrastructure in v2.1. Change-Id: Ie7731c25ee7c5c662c22835add3314ffa51f37bc Closes-Bug: #1490531

2016年04月27日 15:26:03 +05:30

.. include:: extensions.inc

Publish proxy APIs deprecation in api ref doc As first step to deprecate the proxy APIs, this commit publish the deprecation of proxy APIs in api ref doc. Partially implements blueprint deprecate-api-proxies Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f

2016年06月14日 15:31:18 +09:00

.. include:: os-networks.inc

.. include:: os-volumes.inc

.. include:: images.inc

.. include:: os-baremetal-nodes.inc

.. include:: os-tenant-network.inc

.. include:: os-floating-ip-pools.inc

.. include:: os-floating-ips.inc

.. include:: os-security-groups.inc

.. include:: os-security-group-rules.inc

Deprecate os-hosts API This patch deprecates os-hosts APIs including: GET /os-hosts - list hosts GET /os-hosts/{host_name} - show host details PUT /os-hosts/{host_name} - update host status GET /os-hosts/{host_name}/reboot - reboot host GET /os-hosts/{host_name}/shutdown - shutdown host GET /os-hosts/{host_name}/startup - start host Much of the ``os-hosts`` API is duplicated with the ``os-services`` and ``os-hypervisors`` APIs. It's not a good idea to make nova have the compute related API, so this patch deprecated them. Implements blueprint deprecate-os-hosts Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com> Change-Id: Ieb85653b85a1eff38a9fb0c9ff05e4cd39150ecc

2017年03月27日 17:49:11 +08:00

.. include:: os-hosts.inc

Remove nova-cert This commit removes nova-cert which has been deprecated since change Id7a1fc943cbe6d860a50d3cc776717b55351004b. The APIs have been hard coded to return a 410 whenever they're called now. For the API ref a new section for obsolete apis is added to the bottom of the page and the certificates api ref is moved there. Implements bp remove-nova-cert Change-Id: I2c78a0c6599b92040146cf9f0042cff8fd2509c3

2017年04月24日 17:57:57 -04:00

=============

Obsolete APIs

=============

This section contains the reference for APIs that were part of the OpenStack

Compute API in the past, but no longer exist.

.. include:: os-certificates.inc

Remove cloudpipe APIs This commit removes the cloudpipe API from nova. This has been deprecated since change I415760ff634dd85974f0c3f79e788e633852efb5 and no longer works without nova-cert and the pending removal of the deprecated nova-network. Implements bp remove-nova-cert Change-Id: Ifd1fb13a5953cc66f9cc2561d30a9efcd3f4c92e

2017年04月24日 19:43:54 -04:00

.. include:: os-cloudpipe.inc

Remove support for /os-fping REST API This drops support for the fping compute REST API which has been deprecated since Newton: I1a8a44530be29292561e90d6f7bd7ed512a88ee3 To match the os-cloudpipe and os-certificates removals the os-fping controller now returns a 410 response. The related fping_path configuration option is removed along with the related fping policy rules. 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-fping was removed. A release note is started which we can build on for each nova-network specific API that we remove in this series. Part of blueprint remova-nova-network Change-Id: Ia36aaa8f74adc2b540c49523db522cd85ab17ed2

2018年05月10日 15:12:35 -04:00

.. include:: os-fping.inc

Remove support for /os-virtual-interfaces REST API This drops support for the os-virtual-interfaces 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-virtual-interfaces was removed. Depends-On: https://review.openstack.org/571556/ Part of blueprint remove-nova-network Change-Id: Id7f94a643e5d7b8a842c0f4a5c9f796d6566b365

2018年05月16日 11:15:03 +08:00

.. include:: os-virtual-interfaces.inc

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年05月15日 16:22:08 +08:00

.. include:: os-fixed-ips.inc

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月16日 10:43:14 +01:00

.. include:: os-floating-ips-bulk.inc

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月16日 13:25:50 +01:00

.. include:: os-floating-ip-dns.inc

Remove '/os-cells' REST APIs Drop support for the os-cells REST APIs, which are part of the cells v1 feature which has been deprecated since Pike. 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 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 os-cells was removed. A release note added for previous cells v1 removals is amended to note this additional change. Part of blueprint remove-cells-v1 Change-Id: Iddb519008515f591cf1d884872a5887afbe766f2 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>

2019年04月04日 11:47:11 +01:00

.. include:: os-cells.inc

Remove 'os-consoles' API 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>

2019年10月10日 15:13:06 +01:00

.. include:: os-consoles.inc

Remove 'os-security-group-default-rules' REST API 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>

2019年09月21日 22:36:21 +01:00

.. include:: os-security-group-default-rules.inc

api-ref: Move 'os-agents' API to obsolete section Follow up for change I9512f605dd2b3b0e88c951ed086250d57056303d. Change-Id: Ia627bab8ed911baf329e0bda385beb2ffcbbe7d6 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

2020年10月02日 09:40:11 +01:00

.. include:: os-agents.inc

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

93 lines 2.8 KiB ReStructuredText Raw Normal View History Unescape Escape

93 lines

2.8 KiB

ReStructuredText

Raw Normal View History