From 40ea165e81bd563cbba49947d55c3aa102b5daec Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Tue, 14 Jun 2016 15:31:18 +0900 Subject: [PATCH] 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 --- api-ref/source/images.inc | 14 +++++++-- api-ref/source/index.rst | 30 +++++++++---------- api-ref/source/os-baremetal-nodes.inc | 10 +++++-- api-ref/source/os-fixed-ips.inc | 12 ++++++-- api-ref/source/os-floating-ip-dns.inc | 14 +++++++-- api-ref/source/os-floating-ip-pools.inc | 14 +++++++-- api-ref/source/os-floating-ips-bulk.inc | 14 +++++++-- api-ref/source/os-floating-ips.inc | 14 +++++++-- api-ref/source/os-fping.inc | 11 +++++-- api-ref/source/os-networks.inc | 9 ++++-- .../os-security-group-default-rules.inc | 11 +++++-- api-ref/source/os-security-group-rules.inc | 14 +++++++-- api-ref/source/os-security-groups.inc | 14 +++++++-- api-ref/source/os-tenant-network.inc | 14 +++++++-- api-ref/source/os-volumes.inc | 14 +++++++-- 15 files changed, 152 insertions(+), 57 deletions(-) diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index 0dc1bef578ad..527cff6104f5 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -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 + `__. Lists, shows details for, and deletes images. Also sets, lists, shows details for, and deletes image metadata. diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index c8e30a5a7fc0..f4ce4c0115af 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -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 diff --git a/api-ref/source/os-baremetal-nodes.inc b/api-ref/source/os-baremetal-nodes.inc index 7c05566ea16b..46316634eb86 100644 --- a/api-ref/source/os-baremetal-nodes.inc +++ b/api-ref/source/os-baremetal-nodes.inc @@ -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 + `__. Bare metal nodes. diff --git a/api-ref/source/os-fixed-ips.inc b/api-ref/source/os-fixed-ips.inc index 39b9b9a144cc..1f69186b4893 100644 --- a/api-ref/source/os-fixed-ips.inc +++ b/api-ref/source/os-fixed-ips.inc @@ -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. diff --git a/api-ref/source/os-floating-ip-dns.inc b/api-ref/source/os-floating-ip-dns.inc index 60fca454f5bf..969cd625bc8b 100644 --- a/api-ref/source/os-floating-ip-dns.inc +++ b/api-ref/source/os-floating-ip-dns.inc @@ -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 + `__. Manages DNS records associated with floating IP addresses. The API dispatches requests to a DNS driver that is selected at startup. diff --git a/api-ref/source/os-floating-ip-pools.inc b/api-ref/source/os-floating-ip-pools.inc index 5a82a197d53f..e5f5b3eff785 100644 --- a/api-ref/source/os-floating-ip-pools.inc +++ b/api-ref/source/os-floating-ip-pools.inc @@ -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 + `__. Manages groups of floating IPs. diff --git a/api-ref/source/os-floating-ips-bulk.inc b/api-ref/source/os-floating-ips-bulk.inc index 605200bf41a3..a95f80cbfafb 100644 --- a/api-ref/source/os-floating-ips-bulk.inc +++ b/api-ref/source/os-floating-ips-bulk.inc @@ -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 + `__. (nova-network only) Bulk-creates, deletes, and lists floating IPs. Default pool name is ``nova``. diff --git a/api-ref/source/os-floating-ips.inc b/api-ref/source/os-floating-ips.inc index fc19f3d65ca0..8d108ff12d6a 100644 --- a/api-ref/source/os-floating-ips.inc +++ b/api-ref/source/os-floating-ips.inc @@ -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 + `__. Lists floating IP addresses for a project. Also, creates (allocates) a floating IP address for a project, shows floating IP address details, diff --git a/api-ref/source/os-fping.inc b/api-ref/source/os-fping.inc index 21c53917a358..69ba4a68e012 100644 --- a/api-ref/source/os-fping.inc +++ b/api-ref/source/os-fping.inc @@ -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. diff --git a/api-ref/source/os-networks.inc b/api-ref/source/os-networks.inc index b5acfdc7e616..8fb8706e1461 100644 --- a/api-ref/source/os-networks.inc +++ b/api-ref/source/os-networks.inc @@ -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 + `__. + Creates, lists, shows information for, and deletes networks. diff --git a/api-ref/source/os-security-group-default-rules.inc b/api-ref/source/os-security-group-default-rules.inc index 04c22dd00d0c..596b2056b8ce 100644 --- a/api-ref/source/os-security-group-default-rules.inc +++ b/api-ref/source/os-security-group-default-rules.inc @@ -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. diff --git a/api-ref/source/os-security-group-rules.inc b/api-ref/source/os-security-group-rules.inc index 45fc6de3c99c..14e5ee999026 100644 --- a/api-ref/source/os-security-group-rules.inc +++ b/api-ref/source/os-security-group-rules.inc @@ -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 + `__. Creates and deletes security group rules. diff --git a/api-ref/source/os-security-groups.inc b/api-ref/source/os-security-groups.inc index fc2500416747..bac81c51dbd2 100644 --- a/api-ref/source/os-security-groups.inc +++ b/api-ref/source/os-security-groups.inc @@ -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 + `__. Lists, shows information for, creates, updates and deletes security groups. diff --git a/api-ref/source/os-tenant-network.inc b/api-ref/source/os-tenant-network.inc index 9ccf720438a4..fd5e989d7c07 100644 --- a/api-ref/source/os-tenant-network.inc +++ b/api-ref/source/os-tenant-network.inc @@ -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 + `__. Creates, lists, shows information for, and deletes project networks. diff --git a/api-ref/source/os-volumes.inc b/api-ref/source/os-volumes.inc index eeb282f23f26..eafd6d72a341 100644 --- a/api-ref/source/os-volumes.inc +++ b/api-ref/source/os-volumes.inc @@ -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 + `__. Manages volumes and snapshots for use with the Compute API.