openstack/nova
Code Issues Proposed changes

Publish proxy APIs deprecation in api ref doc

Browse Source 
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
This commit is contained in:
ghanshyam 2016-06-14 15:31:18 +09:00
parent 05cab2666f
commit 40ea165e81
15 changed files with 152 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api-ref/source/images.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
========
Images
========
====================
Images (DEPRECATED)
====================
.. warning::
These APIs are proxy calls to the Image service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Image APIs
<http://developer.openstack.org/api-ref-image-v2.html#images-images-v2>`__.
Lists, shows details for, and deletes images. Also sets, lists, shows
details for, and deletes image metadata.

30
api-ref/source/index.rst
View File

@ -32,35 +32,35 @@
.. include:: os-flavor-extra-specs.inc
.. include:: os-keypairs.inc
.. include:: limits.inc
.. include:: images.inc
.. include:: os-agents.inc
.. include:: os-aggregates.inc
.. include:: os-assisted-volume-snapshots.inc
.. include:: os-availability-zone.inc
.. include:: os-baremetal-nodes.inc
.. include:: os-cells.inc
.. include:: os-certificates.inc
.. include:: os-cloudpipe.inc
.. include:: os-consoles.inc
.. include:: os-hosts.inc
.. include:: os-hypervisors.inc
.. include:: os-instance-usage-audit-log.inc
.. include:: os-migrations.inc
.. include:: os-quota-sets.inc
.. include:: os-server-groups.inc
.. include:: os-services.inc
.. include:: os-simple-tenant-usage.inc
.. include:: os-server-external-events.inc
.. include:: extensions.inc
.. include:: os-networks.inc
.. include:: os-volumes.inc
.. include:: images.inc
.. include:: os-baremetal-nodes.inc
.. include:: os-tenant-network.inc
.. include:: os-fixed-ips.inc
.. include:: os-floating-ip-dns.inc
.. include:: os-floating-ip-pools.inc
.. include:: os-floating-ips.inc
.. include:: os-floating-ips-bulk.inc
.. include:: os-fping.inc
.. include:: os-hosts.inc
.. include:: os-hypervisors.inc
.. include:: os-instance-usage-audit-log.inc
.. include:: os-migrations.inc
.. include:: os-networks.inc
.. include:: os-quota-sets.inc
.. include:: os-security-groups.inc
.. include:: os-security-group-default-rules.inc
.. include:: os-security-group-rules.inc
.. include:: os-server-groups.inc
.. include:: os-services.inc
.. include:: os-simple-tenant-usage.inc
.. include:: os-tenant-network.inc
.. include:: os-volumes.inc
.. include:: os-server-external-events.inc
.. include:: extensions.inc

10
api-ref/source/os-baremetal-nodes.inc
View File

@ -1,13 +1,17 @@
.. -*- rst -*-
=======================================
Bare metal nodes (os-baremetal-nodes)
=======================================
===================================================
Bare metal nodes (os-baremetal-nodes) (DEPRECATED)
===================================================
.. warning::
These APIs are proxy calls to the Ironic service. They exist for
legacy compatibility, but no new applications should use them.
Nova has deprecated all the proxy APIs and users should use the native
APIs instead.
See: `Relevant Bare metal APIs
<http://developer.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.
Bare metal nodes.

12
api-ref/source/os-fixed-ips.inc
View File

@ -3,9 +3,15 @@
.. needs:example_verification
.. needs:body_verification
==========================
Fixed IPs (os-fixed-ips)
==========================
======================================
Fixed IPs (os-fixed-ips) (DEPRECATED)
======================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
Shows data for a fixed IP, such as host name, CIDR, and address. Also,
reserves and releases a fixed IP address.

14
api-ref/source/os-floating-ip-dns.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
==============================================
Floating IP DNS records (os-floating-ip-dns)
==============================================
==========================================================
Floating IP DNS records (os-floating-ip-dns) (DEPRECATED)
==========================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html>`__.
Manages DNS records associated with floating IP addresses. The API
dispatches requests to a DNS driver that is selected at startup.

14
api-ref/source/os-floating-ip-pools.inc
View File

@ -1,8 +1,16 @@
.. -*- rst -*-
==========================================
Floating IP pools (os-floating-ip-pools)
==========================================
======================================================
Floating IP pools (os-floating-ip-pools) (DEPRECATED)
======================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html>`__.
Manages groups of floating IPs.

14
api-ref/source/os-floating-ips-bulk.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
==========================================
Floating IPs bulk (os-floating-ips-bulk)
==========================================
======================================================
Floating IPs bulk (os-floating-ips-bulk) (DEPRECATED)
======================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html>`__.
(nova-network only) Bulk-creates, deletes, and lists floating IPs.
Default pool name is ``nova``.

14
api-ref/source/os-floating-ips.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
================================
Floating IPs (os-floating-ips)
================================
============================================
Floating IPs (os-floating-ips) (DEPRECATED)
============================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html#layer3-ext>`__.
Lists floating IP addresses for a project. Also, creates (allocates) a
floating IP address for a project, shows floating IP address details,

11
api-ref/source/os-fping.inc
View File

@ -1,8 +1,13 @@
.. -*- rst -*-
===========================
Ping instances (os-fping)
===========================
=======================================
Ping instances (os-fping) (DEPRECATED)
=======================================
.. warning::
This API only works with ``nova-network`` which is
deprecated. It should be avoided in any new applications.
Pings instances and reports which instances are alive.

9
api-ref/source/os-networks.inc
View File

@ -6,9 +6,9 @@
deprecated methods in this file. Let's not spend a ton of brain
power on the associate/disassociate that's going away.
========================
Networks (os-networks)
========================
=====================================
Networks (os-networks) (DEPRECATED)
=====================================
.. warning:: The networks API was designed to work with
``nova-network``. Some features are proxied to
@ -16,6 +16,9 @@
proxies, this is far from perfect compatibility. These
APIs should be avoided in new applications in favor of
using ``neutron`` directly.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2.html#networks>`__.
Creates, lists, shows information for, and deletes networks.

11
api-ref/source/os-security-group-default-rules.inc
View File

@ -3,9 +3,14 @@
.. needs:example_verification
.. needs:body_verification
====================================================================
Rules for default security group (os-security-group-default-rules)
====================================================================
================================================================================
Rules for default security group (os-security-group-default-rules) (DEPRECATED)
================================================================================
.. warning::
This API only available with ``nova-network`` which is
deprecated. It should be avoided in any new applications.
Lists, shows information for, and creates default security group rules.

14
api-ref/source/os-security-group-rules.inc
View File

@ -2,9 +2,17 @@
.. needs:example_verification
.. needs:body_verification
====================================================
Rules for security group (os-security-group-rules)
====================================================
================================================================
Rules for security group (os-security-group-rules) (DEPRECATED)
================================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html#security_group_rules>`__.
Creates and deletes security group rules.

14
api-ref/source/os-security-groups.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
======================================
Security groups (os-security-groups)
======================================
==================================================
Security groups (os-security-groups) (DEPRECATED)
==================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html#security_groups>`__.
Lists, shows information for, creates, updates and deletes security groups.

14
api-ref/source/os-tenant-network.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
=======================================
Project networks (os-tenant-networks)
=======================================
===================================================
Project networks (os-tenant-networks) (DEPRECATED)
===================================================
.. warning::
These APIs are proxy calls to the Network service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html>`__.
Creates, lists, shows information for, and deletes project networks.

14
api-ref/source/os-volumes.inc
View File

@ -3,9 +3,17 @@
.. needs:example_verification
.. needs:body_verification
=============================================
Volume extension (os-volumes, os-snapshots)
=============================================
=========================================================
Volume extension (os-volumes, os-snapshots) (DEPRECATED)
=========================================================
.. warning::
These APIs are proxy calls to the Volume service. Nova has
deprecated all the proxy APIs and users should use the native APIs
instead.
See: `Relevant Volume APIs
<http://developer.openstack.org/api-ref-blockstorage-v2.html#volumes-v2-volumes>`__.
Manages volumes and snapshots for use with the Compute API.