Browse Source

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
changes/77/672077/3
Andreas Jaeger 2 years ago
parent
commit
dbe6321537
  1. 4
      README.rst
  2. 2
      api-guide/source/faults.rst
  3. 2
      api-guide/source/index.rst
  4. 4
      api-guide/source/limits.rst
  5. 4
      api-guide/source/server_concepts.rst
  6. 2
      api-guide/source/versions.rst
  7. 4
      api-ref/source/images.inc
  8. 2
      api-ref/source/index.rst
  9. 2
      api-ref/source/os-baremetal-nodes.inc
  10. 8
      api-ref/source/os-floating-ips.inc
  11. 4
      api-ref/source/os-hypervisors.inc
  12. 2
      api-ref/source/os-networks.inc
  13. 2
      api-ref/source/os-security-group-rules.inc
  14. 2
      api-ref/source/os-security-groups.inc
  15. 2
      api-ref/source/os-services.inc
  16. 2
      api-ref/source/os-tenant-network.inc
  17. 2
      api-ref/source/os-volumes.inc
  18. 22
      api-ref/source/parameters.yaml
  19. 2
      api-ref/source/request-ids.inc
  20. 10
      api-ref/source/servers-actions.inc
  21. 8
      api-ref/source/servers.inc
  22. 2
      api-ref/source/versions.inc
  23. 2
      doc/README.rst
  24. 2
      doc/source/admin/cells.rst
  25. 2
      doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst
  26. 4
      doc/source/admin/configuration/schedulers.rst
  27. 2
      doc/source/admin/flavors.rst
  28. 2
      doc/source/contributor/api-ref-guideline.rst
  29. 2
      doc/source/contributor/api.rst
  30. 2
      doc/source/contributor/documentation.rst
  31. 2
      doc/source/contributor/microversions.rst
  32. 2
      doc/source/contributor/policies.rst
  33. 6
      doc/source/index.rst
  34. 4
      doc/source/reference/stable-api.rst
  35. 2
      doc/source/user/cells.rst
  36. 30
      doc/source/user/feature-matrix-gp.ini
  37. 4
      doc/source/user/feature-matrix-hpc.ini
  38. 6
      doc/source/user/feature-matrix-nfv.ini
  39. 2
      doc/source/user/flavors.rst
  40. 8
      doc/source/user/quotas.rst
  41. 2
      nova/api/openstack/compute/baremetal_nodes.py
  42. 2
      nova/api/openstack/compute/rest_api_version_history.rst
  43. 2
      nova/conf/api.py
  44. 2
      nova/notifications/objects/image.py
  45. 4
      tox.ini

4
README.rst

@ -21,8 +21,8 @@ API
To learn how to use Nova's API, consult the documentation available online at:
- `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`__
- `Compute API Reference <https://developer.openstack.org/api-ref/compute/>`__
- `Compute API Guide <https://docs.openstack.org/api-guide/compute/>`__
- `Compute API Reference <https://docs.openstack.org/api-ref/compute/>`__
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:

2
api-guide/source/faults.rst

@ -71,7 +71,7 @@ There is an API for end users to list the outcome of Server Actions,
referencing the requested action by request id.
For more details, please see:
https://developer.openstack.org/api-ref/compute/#servers-run-an-action-servers-action
https://docs.openstack.org/api-ref/compute/#servers-run-an-action-servers-action
Logs
----

2
api-guide/source/index.rst

@ -24,7 +24,7 @@ compute resources might be Virtual Machines, Physical Machines or Containers.
This guide covers the concepts in the OpenStack Compute API.
For a full reference listing, please see:
`Compute API Reference <https://developer.openstack.org/api-ref/compute/#compute-api>`__.
`Compute API Reference <https://docs.openstack.org/api-ref/compute/#compute-api>`__.
We welcome feedback, comments, and bug reports at
`bugs.launchpad.net/nova <https://bugs.launchpad.net/nova>`__.

4
api-guide/source/limits.rst

@ -9,7 +9,7 @@ operators and may differ from one deployment of the OpenStack Compute service
to another. Please contact your provider to determine the limits that
apply to your account. Your provider may be able to adjust your
account's limits if they are too low. Also see the API Reference for
`Limits <https://developer.openstack.org/api-ref/compute/#limits-limits>`__.
`Limits <https://docs.openstack.org/api-ref/compute/#limits-limits>`__.
Absolute limits
~~~~~~~~~~~~~~~
@ -49,4 +49,4 @@ Determine limits programmatically
Applications can programmatically determine current account limits. For
information, see
`Limits <https://developer.openstack.org/api-ref/compute/#limits-limits>`__.
`Limits <https://docs.openstack.org/api-ref/compute/#limits-limits>`__.

4
api-guide/source/server_concepts.rst

@ -708,7 +708,7 @@ For more information, refer to `Block Device Mapping
For the full list of ``block_device_mapping_v2`` parameters available when
creating a server, see the `API reference
<https://developer.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server>`_.
<https://docs.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server>`_.
**Example for block_device_mapping_v2**
@ -767,7 +767,7 @@ For more information on how scheduler hints are different from flavor extra
specs, refer to `this document`_.
.. _cloud's configuration: https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html
.. _the create-server-detail Request section: https://developer.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server
.. _the create-server-detail Request section: https://docs.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server
.. _this document: https://docs.openstack.org/nova/latest/reference/scheduler-hints-vs-flavor-extra-specs.html#scheduler-hints
Server Consoles

2
api-guide/source/versions.rst

@ -105,7 +105,7 @@ server might respond with a 302 redirection request.
For examples of the list versions and get version details requests and
responses, see `API versions
<https://developer.openstack.org/api-ref/compute/#api-versions>`__.
<https://docs.openstack.org/api-ref/compute/#api-versions>`__.
The detailed version response contains pointers to both a human-readable
and a machine-processable description of the API service.

4
api-ref/source/images.inc

@ -13,7 +13,7 @@
The image metadata APIs will fail with a 404 starting from
microversion 2.39.
See: `Relevant Image APIs
<https://developer.openstack.org/api-ref/image/v2/index.html>`__.
<https://docs.openstack.org/api-ref/image/v2/index.html>`__.
Lists, shows details and deletes images.
Also sets, lists, shows details, create, update and deletes image metadata.
@ -21,7 +21,7 @@ Also sets, lists, shows details, create, update and deletes image metadata.
An image is a collection of files that you use to create and rebuild a
server. By default, operators provide pre-built operating system images.
You can also create custom images. See: `Create Image Action
<https://developer.openstack.org/api-ref/compute/#create-image-createimage-action>`__.
<https://docs.openstack.org/api-ref/compute/#create-image-createimage-action>`__.
By default, the ``policy.json`` file authorizes all users to view the
image size in the ``OS-EXT-IMG-SIZE:size`` extended attribute.

2
api-ref/source/index.rst

@ -6,7 +6,7 @@
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
the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
the `API guide <https://docs.openstack.org/api-guide/compute/index.html>`_.
.. rest_expand_all::

2
api-ref/source/os-baremetal-nodes.inc

@ -11,7 +11,7 @@
Nova has deprecated all the proxy APIs and users should use the native
APIs instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Bare metal APIs
<http://developer.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.
<https://docs.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.
Bare metal nodes.

8
api-ref/source/os-floating-ips.inc

@ -10,7 +10,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.
Lists floating IP addresses for a project. Also, creates (allocates) a
floating IP address for a project, shows floating IP address details,
@ -20,17 +20,17 @@ The cloud administrator configures a pool of floating IP addresses in
OpenStack Compute. The project quota defines the maximum number of
floating IP addresses that you can allocate to the project. After you
`allocate a floating IP
address <https://developer.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
address <https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
for a project, you can:
- `Add (associate) the floating IP
address <https://developer.openstack.org/api-ref/compute/#add-associate-floating-ip-
address <https://docs.openstack.org/api-ref/compute/#add-associate-floating-ip-
addfloatingip-action-deprecated>`__
with an instance in the project. You can associate only one floating
IP address with an instance at a time.
- `Remove (disassociate) the floating IP
address <https://developer.openstack.org/api-ref/compute/#remove-disassociate-
address <https://docs.openstack.org/api-ref/compute/#remove-disassociate-
floating-ip-removefloatingip-action-deprecated>`__
from an instance in the project.

4
api-ref/source/os-hypervisors.inc

@ -154,7 +154,7 @@ the ``policy.json`` file.
the totals and the usages. A more accurate representation of state can be
obtained using `placement`__.
__ https://developer.openstack.org/api-ref/placement/#list-resource-provider-usages
__ https://docs.openstack.org/api-ref/placement/#list-resource-provider-usages
Normal response codes: 200
@ -202,7 +202,7 @@ the ``policy.json`` file.
the totals and the usages. A more accurate representation of state can be
obtained using `placement`__.
__ https://developer.openstack.org/api-ref/placement/#show-resource-provider-usages
__ https://docs.openstack.org/api-ref/placement/#show-resource-provider-usages
Normal response codes: 200

2
api-ref/source/os-networks.inc

@ -14,7 +14,7 @@
using ``neutron`` directly. These will fail with a 404
starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.
Creates, lists, shows information for, and deletes networks.

2
api-ref/source/os-security-group-rules.inc

@ -10,7 +10,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#security-group-rules-security-group-rules>`__.
<https://docs.openstack.org/api-ref/network/v2/#security-group-rules-security-group-rules>`__.
Creates and deletes security group rules.

2
api-ref/source/os-security-groups.inc

@ -12,7 +12,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#security-groups-security-groups>`__.
<https://docs.openstack.org/api-ref/network/v2/#security-groups-security-groups>`__.
Lists, shows information for, creates, updates and deletes security groups.

2
api-ref/source/os-services.inc

@ -25,7 +25,7 @@ Provides details why any services were disabled.
due to a transient condition in the deployment like infrastructure failure,
the response body for those unavailable compute services in the down cells
will be missing keys. See `handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.

2
api-ref/source/os-tenant-network.inc

@ -12,7 +12,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.
Creates, lists, shows information for, and deletes project networks.

2
api-ref/source/os-volumes.inc

@ -10,7 +10,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Volume APIs
<https://developer.openstack.org/api-ref/block-storage/v3/index.html>`__.
<https://docs.openstack.org/api-ref/block-storage/v3/index.html>`__.
Manages volumes and snapshots for use with the Compute API.
Lists, shows details, creates, and deletes volumes and snapshots.

22
api-ref/source/parameters.yaml

@ -2348,7 +2348,7 @@ device_volume_type:
The device ``volume_type``. This can be used to specify the type of volume
which the compute service will create and attach to the server.
If not specified, the block storage service will provide a default volume
type. See the `block storage volume types API <https://developer.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
type. See the `block storage volume types API <https://docs.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
for more details.
There are some restrictions on ``volume_type``:
@ -2980,7 +2980,7 @@ flavor_links_2_46:
description: |
Links to the flavor resource. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: true
@ -3611,7 +3611,7 @@ hypervisor_links:
description: |
Links to the hypervisors resource. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
@ -3926,7 +3926,7 @@ instance_actions_next_links:
Links pertaining to the instance action.
This parameter is returned when paging and more data is available.
See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: false
@ -4177,7 +4177,7 @@ keypair_links:
description: |
Links pertaining to keypair. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
@ -4294,7 +4294,7 @@ links:
description: |
Links to the resources in question. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: true
@ -4617,7 +4617,7 @@ migration_links_2_23:
This parameter is returned if the migration type is ``live-migration`` and
the migration status is one of ``queued``, ``preparing``, ``running``
and ``post-migrating``. See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: false
@ -4640,7 +4640,7 @@ migration_next_links_2_59:
Links pertaining to the migration.
This parameter is returned when paging and more data is available.
See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: false
@ -6016,7 +6016,7 @@ server_links:
description: |
Links pertaining to the server. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
@ -6159,7 +6159,7 @@ servers_links:
Links to the next server. It is available when the number of servers exceeds
``limit`` parameter or ``[api]/max_limit`` in the configuration file.
See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
@ -6707,7 +6707,7 @@ usage_links:
description: |
Links pertaining to usage. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array

2
api-ref/source/request-ids.inc

@ -8,7 +8,7 @@ Users can specify the global request ID in the request header.
Users can receive the local request ID in the response header.
For more details about Request IDs, please reference: `Faults
<https://developer.openstack.org/api-guide/compute/faults.html>`_
<https://docs.openstack.org/api-guide/compute/faults.html>`_
**Request**

10
api-ref/source/servers-actions.inc

@ -38,7 +38,7 @@ A pool of floating IP addresses, configured by the cloud administrator,
is available in OpenStack Compute. The project quota defines the maximum
number of floating IP addresses that you can allocate to the project.
After you `create (allocate) a floating IPaddress
<http://developer.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
<https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
for a project, you can associate that address with the server. Specify
the ``addFloatingIp`` action in the request body.
@ -380,23 +380,23 @@ Specify the ``lock`` action in the request body.
Most actions by non-admin users are not allowed to the server
after this operation is successful and the server is locked.
See the "Lock, Unlock" item in `Server actions
<https://developer.openstack.org/api-guide/compute/server_concepts.html#server-actions>`_
<https://docs.openstack.org/api-guide/compute/server_concepts.html#server-actions>`_
for the restricted actions.
But administrators can perform actions on the server
even though the server is locked. Note that from microversion 2.73 it is
possible to specify a reason when locking the server.
The `unlock action
<https://developer.openstack.org/api-ref/compute/#unlock-server-unlock-action>`_
<https://docs.openstack.org/api-ref/compute/#unlock-server-unlock-action>`_
will unlock a server in locked state so additional actions can
be performed on the server by non-admin users.
You can know whether a server is locked or not and the ``locked_reason``
(if specified, from the 2.73 microversion) by the `List Servers Detailed API
<https://developer.openstack.org/api-ref/compute/#list-servers-detailed>`_
<https://docs.openstack.org/api-ref/compute/#list-servers-detailed>`_
or
the `Show Server Details API
<https://developer.openstack.org/api-ref/compute/#show-server-details>`_.
<https://docs.openstack.org/api-ref/compute/#show-server-details>`_.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers

8
api-ref/source/servers.inc

@ -183,7 +183,7 @@ whitelist will be silently ignored.
due to a transient condition in the deployment like infrastructure failure,
the response body for those unavailable servers will be missing keys. See
`handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.
@ -301,7 +301,7 @@ request body to boot a server from a volume.
Include the ``key_name`` parameter in the create request body to add a
keypair to the server when you create it. To create a keypair, make a
`create keypair
<http://developer.openstack.org/api-ref/compute/#create-or-import-keypair>`__
<https://docs.openstack.org/api-ref/compute/#create-or-import-keypair>`__
request.
.. note:: Starting with microversion 2.37 the ``networks`` field is required.
@ -530,7 +530,7 @@ HostId is unique per account and is not globally unique.
due to a transient condition in the deployment like infrastructure failure,
the response body for those unavailable servers will be missing keys. See
`handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.
@ -699,7 +699,7 @@ The server must exist.
due to a transient condition in the deployment like infrastructure failure,
the response body for the unavailable server will be missing keys. See
`handling down cells
<http://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.

2
api-ref/source/versions.inc

@ -14,7 +14,7 @@ supports versioning. There are two kinds of versions in Nova.
For more details about Microversions, please reference:
`Microversions
<https://developer.openstack.org/api-guide/compute/microversions.html>`_
<https://docs.openstack.org/api-guide/compute/microversions.html>`_
.. note:: The maximum microversion supported by each release varies.
Please reference:

2
doc/README.rst

@ -8,7 +8,7 @@ Contributor developer docs are built to:
https://docs.openstack.org/nova/latest/
API guide docs are built to:
https://developer.openstack.org/api-guide/compute/
https://docs.openstack.org/api-guide/compute/
For more details, see the "Building the Documentation" section of
doc/source/contributor/development-environment.rst.

2
doc/source/admin/cells.rst

@ -13,7 +13,7 @@ Handling cell failures
----------------------
For an explanation on how ``nova-api`` handles cell failures please see the
`Handling Down Cells <https://developer.openstack.org/api-guide/compute/down_cells.html>`__
`Handling Down Cells <https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide. Below, you can find some recommended practices and
considerations for effectively tolerating cell failure situations.

2
doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst

@ -94,7 +94,7 @@ Show instance usage statistics
have a standard format as below. Before microversion 2.48, each hypervisor
had its own format. For more details on diagnostics response message see
`server diagnostics api
<https://developer.openstack.org/api-ref/compute/#servers-diagnostics-servers-diagnostics>`__
<https://docs.openstack.org/api-ref/compute/#servers-diagnostics-servers-diagnostics>`__
documentation.
.. code-block:: console

4
doc/source/admin/configuration/schedulers.rst

@ -97,7 +97,7 @@ provider, the trait will be synchronized when the ``update_available_resource``
periodic task runs - which is controlled by the
:oslo.config:option:`update_resources_interval` configuration option.
.. _os-services: https://developer.openstack.org/api-ref/compute/#compute-services-os-services
.. _os-services: https://docs.openstack.org/api-ref/compute/#compute-services-os-services
Filter scheduler
@ -1463,7 +1463,7 @@ the configuration settings alone.
See `bug 1804125 <https://bugs.launchpad.net/nova/+bug/1804125>`_ for more
details.
.. _resource provider inventory: https://developer.openstack.org/api-ref/placement/?expanded=#resource-provider-inventories
.. _resource provider inventory: https://docs.openstack.org/api-ref/placement/?expanded=#resource-provider-inventories
Usage scenarios
---------------

2
doc/source/admin/flavors.rst

@ -135,7 +135,7 @@ and a new description as follows:
instances if required but as a resize performs a cold migration
it is not transparent to a tenant.
.. _updating flavor extra_specs: https://developer.openstack.org/api-ref/compute/?expanded=#update-an-extra-spec-for-a-flavor
.. _updating flavor extra_specs: https://docs.openstack.org/api-ref/compute/?expanded=#update-an-extra-spec-for-a-flavor
Delete a flavor
---------------

2
doc/source/contributor/api-ref-guideline.rst

@ -9,7 +9,7 @@ This page describes the guideline for updating the API reference.
API reference
=============
* `Compute API reference <https://developer.openstack.org/api-ref/compute/>`_
* `Compute API reference <https://docs.openstack.org/api-ref/compute/>`_
The guideline to write the API reference
========================================

2
doc/source/contributor/api.rst

@ -311,4 +311,4 @@ The general steps for removing support for a deprecated REST API are:
Here is an example of the above steps: https://review.opendev.org/567682/
.. _route mapping: https://opendev.org/openstack/nova/src/branch/master/nova/api/openstack/compute/routes.py
.. _Obsolete APIs: https://developer.openstack.org/api-ref/compute/#obsolete-apis
.. _Obsolete APIs: https://docs.openstack.org/api-ref/compute/#obsolete-apis

2
doc/source/contributor/documentation.rst

@ -47,7 +47,7 @@ every stable release (e.g. ``pike``).
unimproved as we address content in ``latest``.
The ``api-ref`` and ``api-guide`` publish only from master to a single site on
`developer.openstack.org`. As such, they are effectively branchless.
`docs.openstack.org`. As such, they are effectively branchless.
Guidelines for consumable docs
==============================

2
doc/source/contributor/microversions.rst

@ -377,7 +377,7 @@ necessary to add changes to other places which describe your change:
* Update the `API Reference`_ documentation as appropriate. The source is
located under `api-ref/source/`.
.. _API Reference: https://developer.openstack.org/api-ref/compute/
.. _API Reference: https://docs.openstack.org/api-ref/compute/
Allocating a microversion
-------------------------

2
doc/source/contributor/policies.rst

@ -33,7 +33,7 @@ Public Contractual APIs
Although nova has many internal APIs, they are not all public contractual
APIs. Below is a link of our public contractual APIs:
* https://developer.openstack.org/api-ref/compute/
* https://docs.openstack.org/api-ref/compute/
Anything not in this list is considered private, not to be used outside of
nova, and should not be considered stable.

6
doc/source/index.rst

@ -70,15 +70,15 @@ API, which can be used to build more complicated logic or automation with
nova. This can be consumed directly, or via various SDKs. The following
resources will help you get started with consuming the API directly.
* `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`_: The
* `Compute API Guide <https://docs.openstack.org/api-guide/compute/>`_: The
concept guide for the API. This helps lay out the concepts behind the API to
make consuming the API reference easier.
* `Compute API Reference <http://developer.openstack.org/api-ref/compute/>`_:
* `Compute API Reference <https://docs.openstack.org/api-ref/compute/>`_:
The complete reference for the compute API, including all methods and
request / response parameters and their meaning.
* :doc:`Compute API Microversion History </reference/api-microversion-history>`:
The compute API evolves over time through `Microversions
<https://developer.openstack.org/api-guide/compute/microversions.html>`_. This
<https://docs.openstack.org/api-guide/compute/microversions.html>`_. This
provides the history of all those changes. Consider it a "what's new" in the
compute API.
* :doc:`Block Device Mapping </user/block-device-mapping>`: One of the trickier

4
doc/source/reference/stable-api.rst

@ -36,7 +36,7 @@ Newer code is called the "v2.1 API" and exists in the
The v2 API is the old Nova REST API. It is mostly replaced by v2.1 API.
The v2.1 API is the new Nova REST API with a set of improvements which
includes `Microversion <https://developer.openstack.org/api-guide/compute/microversions.html>`_
includes `Microversion <https://docs.openstack.org/api-guide/compute/microversions.html>`_
and standardized validation of inputs using JSON-Schema.
Also the v2.1 API is totally backwards compatible with the v2 API (That is the
reason we call it as v2.1 API).
@ -124,7 +124,7 @@ for more information.
The '/extensions' API exposed the list of enabled API functions to users
by GET method. However as the above, new API extensions should not be added
to the list of this API. The '/extensions' API is frozen in Nova V2.1 API and
is `deprecated <https://developer.openstack.org/api-ref/compute/#extensions-extensions-deprecated>`_.
is `deprecated <https://docs.openstack.org/api-ref/compute/#extensions-extensions-deprecated>`_.
Things which are History now
****************************

2
doc/source/user/cells.rst

@ -751,7 +751,7 @@ FAQs
``GET /servers/detail``, ``GET /servers/{server_id}`` and
``GET /os-services`` may contain missing keys during down cell situations.
See the `Handling Down Cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the partial
constructs.

30
doc/source/user/feature-matrix-gp.ini

@ -66,7 +66,7 @@ notes=This includes creating a server, and deleting a server.
Specifically this is about booting a server from a glance image
using the default disk and network configuration.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/#servers-servers
api_doc_link=https://docs.openstack.org/api-ref/compute/#servers-servers
admin_doc_link=https://docs.openstack.org/nova/latest/user/launch-instances.html
tempest_test_uuids=9a438d88-10c6-4bcd-8b5b-5b6e25e1346f;585e934c-448e-43c4-acbf-d06a9b899997
libvirt-kvm=complete
@ -87,7 +87,7 @@ zvm=complete
title=Snapshot Server
notes=This is creating a glance image from the currently running server.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
api_doc_link=https://docs.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
admin_doc_link=https://docs.openstack.org/glance/latest/admin/troubleshooting.html
tempest_test_uuids=aaacd1d0-55a2-4ce8-818a-b5439df8adc9
cli=
@ -109,7 +109,7 @@ zvm=complete
title=Server power ops
notes=This includes reboot, shutdown and start.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
api_doc_link=https://docs.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
tempest_test_uuids=2cb1baf6-ac8d-4429-bf0d-ba8a0ba53e32;af8eafd4-38a7-4a4b-bdbc-75145a580560
cli=
libvirt-kvm=complete
@ -130,7 +130,7 @@ zvm=complete
title=Rebuild Server
notes=You can rebuild a server, optionally specifying the glance image to use.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
api_doc_link=https://docs.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
tempest_test_uuids=aaa6cdf3-55a7-461a-add9-1c8596b9a07c
cli=
libvirt-kvm=complete
@ -152,7 +152,7 @@ title=Resize Server
notes=You resize a server to a new flavor, then confirm or revert that
operation.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
api_doc_link=https://docs.openstack.org/api-ref/compute/?expanded=#servers-run-an-action-servers-action
tempest_test_uuids=1499262a-9328-4eda-9068-db1ac57498d2
cli=
libvirt-kvm=complete
@ -172,7 +172,7 @@ zvm=missing
title=Volume Operations
notes=This is about attaching volumes, detaching volumes.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/#servers-with-volume-attachments-servers-os-volume-attachments
api_doc_link=https://docs.openstack.org/api-ref/compute/#servers-with-volume-attachments-servers-os-volume-attachments
admin_doc_link=https://docs.openstack.org/cinder/latest/admin/blockstorage-manage-volumes.html
tempest_test_uuids=fff42874-7db5-4487-a8e1-ddda5fb5288d
cli=
@ -197,7 +197,7 @@ notes=This is about supporting all the features of BDMv2.
specifying a custom set of ephemeral disks. Note some drivers
only supports part of what the API allows.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?expanded=create-image-createimage-action-detail#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/?expanded=create-image-createimage-action-detail#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/user/block-device-mapping.html
tempest_test_uuids=557cd2c2-4eb8-4dce-98be-f86765ff311b, 36c34c67-7b54-4b59-b188-02a2f458a63b
cli=
@ -221,7 +221,7 @@ notes=This is about supporting booting from one or more neutron ports,
or all the related short cuts such as booting a specified network.
This does not include SR-IOV or similar, just simple neutron ports.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?&expanded=create-server-detail
api_doc_link=https://docs.openstack.org/api-ref/compute/?&expanded=create-server-detail
admin_doc_link=
tempest_test_uuids=2f3a0127-95c7-4977-92d2-bc5aec602fb4
cli=
@ -246,7 +246,7 @@ driver-notes-zvm=This is not tested in a CI system, but it is implemented.
title=Pause a Server
notes=This is pause and unpause a server, where the state is held in memory.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?#pause-server-pause-action
api_doc_link=https://docs.openstack.org/api-ref/compute/?#pause-server-pause-action
admin_doc_link=
tempest_test_uuids=bd61a9fd-062f-4670-972b-2d6c3e3b9e73
cli=
@ -268,7 +268,7 @@ zvm=complete
title=Suspend a Server
notes=This suspend and resume a server, where the state is held on disk.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/?expanded=suspend-server-suspend-action-detail
api_doc_link=https://docs.openstack.org/api-ref/compute/?expanded=suspend-server-suspend-action-detail
admin_doc_link=
tempest_test_uuids=0d8ee21e-b749-462d-83da-b85b41c86c7f
cli=
@ -290,7 +290,7 @@ zvm=missing
title=Server console output
notes=This gets the current server console output.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/#show-console-output-os-getconsoleoutput-action
api_doc_link=https://docs.openstack.org/api-ref/compute/#show-console-output-os-getconsoleoutput-action
admin_doc_link=
tempest_test_uuids=4b8867e6-fffa-4d54-b1d1-6fdda57be2f3
cli=
@ -313,7 +313,7 @@ title=Server Rescue
notes=This boots a server with a new root disk from the specified glance image
to allow a user to fix a boot partition configuration, or similar.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/#rescue-server-rescue-action
api_doc_link=https://docs.openstack.org/api-ref/compute/#rescue-server-rescue-action
admin_doc_link=
tempest_test_uuids=fd032140-714c-42e4-a8fd-adcd8df06be6;70cdb8a1-89f8-437d-9448-8844fd82bf46
cli=
@ -336,7 +336,7 @@ title=Server Config Drive
notes=This ensures the user data provided by the user when booting
a server is available in one of the expected config drive locations.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/admin/config-drive.html
tempest_test_uuids=7fff3fb3-91d8-4fd0-bd7d-0204f1f180ba
cli=
@ -358,7 +358,7 @@ zvm=complete
title=Server Change Password
notes=The ability to reset the password of a user within the server.
maturity=experimental
api_doc_link=http://developer.openstack.org/api-ref/compute/#change-administrative-password-changepassword-action
api_doc_link=https://docs.openstack.org/api-ref/compute/#change-administrative-password-changepassword-action
admin_doc_link=
tempest_test_uuids=6158df09-4b82-4ab3-af6d-29cf36af858d
cli=
@ -383,7 +383,7 @@ notes=The ability to keep a server logically alive, but not using any
cloud resources. For local disk based instances, this involves taking
a snapshot, called offloading.
maturity=complete
api_doc_link=http://developer.openstack.org/api-ref/compute/#shelve-server-shelve-action
api_doc_link=https://docs.openstack.org/api-ref/compute/#shelve-server-shelve-action
admin_doc_link=
tempest_test_uuids=1164e700-0af0-4a4c-8792-35909a88743c,c1b6318c-b9da-490b-9c67-9339b627271f
cli=

4
doc/source/user/feature-matrix-hpc.ini

@ -47,7 +47,7 @@ notes=The PCI passthrough feature in OpenStack allows full access and direct
installation is the only requirement for the guest to properly use the
devices.
maturity=experimental
api_doc_link=https://developer.openstack.org/api-ref/compute/#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/admin/pci-passthrough.html
tempest_test_uuids=9a438d88-10c6-4bcd-8b5b-5b6e25e1346f;585e934c-448e-43c4-acbf-d06a9b899997
libvirt-kvm=complete:l
@ -68,7 +68,7 @@ powervm=missing
title=Virtual GPUs
notes=Attach a virtual GPU to an instance at server creation time
maturity=experimental
api_doc_link=https://developer.openstack.org/api-ref/compute/#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/admin/virtual-gpu.html
libvirt-kvm=partial:queens
libvirt-kvm-s390=unknown

6
doc/source/user/feature-matrix-nfv.ini

@ -28,7 +28,7 @@ link=https://wiki.openstack.org/wiki/ThirdPartySystems/XenProject_CI
title=NUMA Placement
notes=Configure placement of instance vCPUs and memory across host NUMA nodes
maturity=experimental
api_doc_link=https://developer.openstack.org/api-ref/compute/#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/admin/cpu-topologies.html#customizing-instance-cpu-pinning-policies
tempest_test_uuids=9a438d88-10c6-4bcd-8b5b-5b6e25e1346f;585e934c-448e-43c4-acbf-d06a9b899997
libvirt-kvm=partial
@ -39,7 +39,7 @@ libvirt-xen=missing
title=CPU Pinning Policy
notes=Enable/disable binding of instance vCPUs to host CPUs
maturity=experimental
api_doc_link=https://developer.openstack.org/api-ref/compute/#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/admin/cpu-topologies.html#customizing-instance-cpu-pinning-policies
libvirt-kvm=partial
libvirt-kvm-s390=unknown
@ -49,7 +49,7 @@ libvirt-xen=missing
title=CPU Pinning Thread Policy
notes=Configure usage of host hardware threads when pinning is used
maturity=experimental
api_doc_link=https://developer.openstack.org/api-ref/compute/#create-server
api_doc_link=https://docs.openstack.org/api-ref/compute/#create-server
admin_doc_link=https://docs.openstack.org/nova/latest/admin/cpu-topologies.html#customizing-instance-cpu-pinning-policies
libvirt-kvm=partial
libvirt-kvm-s390=unknown

2
doc/source/user/flavors.rst

@ -731,7 +731,7 @@ Required traits
the set of traits specified in the flavor. The traits are associated with
the resource provider that represents the compute node in the Placement
API. See the resource provider traits API reference for more details:
https://developer.openstack.org/api-ref/placement/#resource-provider-traits
https://docs.openstack.org/api-ref/placement/#resource-provider-traits
The syntax of the extra spec is ``trait:<trait_name>=required``, for
example:

8
doc/source/user/quotas.rst

@ -35,9 +35,9 @@ limits can be set per-tenant using the `quota sets`_ REST API or per class
(all tenants) using the `quota class sets`_ API.
.. _count resource usage: https://specs.openstack.org/openstack/nova-specs/specs/pike/implemented/cells-count-resources-to-check-quota-in-api.html
.. _limits: https://developer.openstack.org/api-ref/compute/#limits-limits
.. _quota sets: https://developer.openstack.org/api-ref/compute/#quota-sets-os-quota-sets
.. _quota class sets: https://developer.openstack.org/api-ref/compute/#quota-class-sets-os-quota-class-sets
.. _limits: https://docs.openstack.org/api-ref/compute/#limits-limits
.. _quota sets: https://docs.openstack.org/api-ref/compute/#quota-sets-os-quota-sets
.. _quota class sets: https://docs.openstack.org/api-ref/compute/#quota-class-sets-os-quota-class-sets
Checking quota
==============
@ -128,7 +128,7 @@ placement:
user does not have enough quota available to support the cores and ram needed
by the server to be unshelved.
.. _down or poor-performing cells: https://developer.openstack.org/api-guide/compute/down_cells.html
.. _down or poor-performing cells: https://docs.openstack.org/api-guide/compute/down_cells.html
Known issues

2
nova/api/openstack/compute/baremetal_nodes.py

@ -51,7 +51,7 @@ def _get_ironic_client():
# TODO(NobodyCam): Fix insecure setting
# NOTE(efried): This should all be replaced by ksa adapter options; but the
# nova-to-baremetal API is deprecated, so not changing it.
# https://developer.openstack.org/api-ref/compute/#bare-metal-nodes-os-baremetal-nodes-deprecated # noqa
# https://docs.openstack.org/api-ref/compute/#bare-metal-nodes-os-baremetal-nodes-deprecated # noqa
kwargs = {'os_username': CONF.ironic.admin_username,
'os_password': CONF.ironic.admin_password,
'os_auth_url': CONF.ironic.admin_url,

2
nova/api/openstack/compute/rest_api_version_history.rst

@ -877,7 +877,7 @@ down part of the infrastructure for the above four requests will have missing
key values to make it more resilient. The response body will only have a
minimal set of information obtained from the available information in the API
database for the down cells. See `handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__ for
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__ for
more information.
2.70

2
nova/conf/api.py

@ -365,7 +365,7 @@ Note that from API microversion 2.69 there could be transient conditions in the
deployment where certain records are not available and the results could be
partial for certain requests containing those records. In those cases this
option will be ignored. See "Handling Down Cells" section of the Compute API
guide (https://developer.openstack.org/api-guide/compute/down_cells.html) for
guide (https://docs.openstack.org/api-guide/compute/down_cells.html) for
more information.
"""),
]

2
nova/notifications/objects/image.py

@ -47,7 +47,7 @@ class ImageMetaPayload(base.NotificationPayloadBase):
# a. It is defined as "The value might be null (JSON null data type)."
# in the "Show image" API (GET /v2/images/{image_id})
# in the glance API v2 Reference.
# (https://developer.openstack.org/api-ref/image/v2/index.html)
# (https://docs.openstack.org/api-ref/image/v2/index.html)
#
# * checksum
# * container_format

4
tox.ini

@ -178,7 +178,7 @@ commands =
[testenv:api-guide]
description =
Generate the API guide. Called from CI scripts to test and publish to developer.openstack.org.
Generate the API guide. Called from CI scripts to test and publish to docs.openstack.org.
envdir = {toxworkdir}/docs
deps = {[testenv:docs]deps}
commands =
@ -187,7 +187,7 @@ commands =
[testenv:api-ref]
description =
Generate the API ref. Called from CI scripts to test and publish to developer.openstack.org.
Generate the API ref. Called from CI scripts to test and publish to docs.openstack.org.
envdir = {toxworkdir}/docs
deps = {[testenv:docs]deps}
commands =

Loading…
Cancel
Save