From 9f9c40d56954baf183968b6ea9db9aec62f4c064 Mon Sep 17 00:00:00 2001
From: Mahesh K P <maheshp@thoughtworks.com>
Date: Wed, 17 Apr 2013 11:41:41 +0530
Subject: Return Customer's Quota Usage through Admin API

DocImpact: This patch adds an extension 'UsedLimitsForAdmin'. If this
extention is enabled then it extends the used limits API behavior, such
that admin can fetch the details of any customer's quota usage by passing
the customer's tenant id in query parameters.The API signature for the
same is 'v2/{tenant_id}/limits?tenant_id={customer_tenant_id}'

Change-Id: I89b8b5083e46b899458407426c89a3865e960faa
Implements: blueprint customer-quota-through-admin-api
---
 .../all_extensions/extensions-get-resp.json        |  8 ++
 .../all_extensions/extensions-get-resp.xml         |  3 +
 .../usedlimitsforadmin-get-resp.json               | 90 ++++++++++++++++++++++
 .../usedlimitsforadmin-get-resp.xml                | 37 +++++++++
 4 files changed, 138 insertions(+)
 create mode 100644 doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.json
 create mode 100644 doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml

(limited to 'doc')

diff --git a/doc/api_samples/all_extensions/extensions-get-resp.json b/doc/api_samples/all_extensions/extensions-get-resp.json
index d7c2a646c..258bbb852 100644
--- a/doc/api_samples/all_extensions/extensions-get-resp.json
+++ b/doc/api_samples/all_extensions/extensions-get-resp.json
@@ -496,6 +496,14 @@
             "namespace": "http://docs.openstack.org/compute/ext/used_limits/api/v1.1",
             "updated": "2012-07-13T00:00:00+00:00"
         },
+        {
+            "alias": "os-used-limits-for-admin",
+            "description": "Provide data to admin on limited resources used by other tenants.",
+            "links": [],
+            "name": "UsedLimitsForAdmin",
+            "namespace": "http://docs.openstack.org/compute/ext/used_limits_for_admin/api/v1.1",
+            "updated": "2013-05-02T00:00:00+00:00"
+        },
         {
             "alias": "os-user-data",
             "description": "Add user_data to the Create Server v1.1 API.",
diff --git a/doc/api_samples/all_extensions/extensions-get-resp.xml b/doc/api_samples/all_extensions/extensions-get-resp.xml
index f6213a3a9..457cb5635 100644
--- a/doc/api_samples/all_extensions/extensions-get-resp.xml
+++ b/doc/api_samples/all_extensions/extensions-get-resp.xml
@@ -204,6 +204,9 @@
   <extension alias="os-used-limits" updated="2012-07-13T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/used_limits/api/v1.1" name="UsedLimits">
     <description>Provide data on limited resources that are being used.</description>
   </extension>
+  <extension alias="os-used-limits-for-admin" updated="2013-05-02T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/used_limits_for_admin/api/v1.1" name="UsedLimitsForAdmin">
+    <description>Provide data to admin on limited resources used by other tenants.</description>
+  </extension>
   <extension alias="os-user-data" updated="2012-08-07T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/userdata/api/v1.1" name="UserData">
     <description>Add user_data to the Create Server v1.1 API.</description>
   </extension>
diff --git a/doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.json b/doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.json
new file mode 100644
index 000000000..c5593b7e7
--- /dev/null
+++ b/doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.json
@@ -0,0 +1,90 @@
+{
+    "limits": {
+        "absolute": {
+            "maxImageMeta": 128,
+            "maxPersonality": 5,
+            "maxPersonalitySize": 10240,
+            "maxSecurityGroupRules": 20,
+            "maxSecurityGroups": 10,
+            "maxServerMeta": 128,
+            "maxTotalCores": 20,
+            "maxTotalFloatingIps": 10,
+            "maxTotalInstances": 10,
+            "maxTotalKeypairs": 100,
+            "maxTotalRAMSize": 51200,
+            "totalCoresUsed": 0,
+            "totalInstancesUsed": 0,
+            "totalRAMUsed": 0,
+            "totalSecurityGroupsUsed": 0,
+            "totalFloatingIpsUsed": 0
+        },
+        "rate": [
+            {
+                "limit": [
+                    {
+                        "next-available": "2012-11-27T17:24:52Z",
+                        "remaining": 10,
+                        "unit": "MINUTE",
+                        "value": 10,
+                        "verb": "POST"
+                    },
+                    {
+                        "next-available": "2012-11-27T17:24:52Z",
+                        "remaining": 10,
+                        "unit": "MINUTE",
+                        "value": 10,
+                        "verb": "PUT"
+                    },
+                    {
+                        "next-available": "2012-11-27T17:24:52Z",
+                        "remaining": 100,
+                        "unit": "MINUTE",
+                        "value": 100,
+                        "verb": "DELETE"
+                    }
+                ],
+                "regex": ".*",
+                "uri": "*"
+            },
+            {
+                "limit": [
+                    {
+                        "next-available": "2012-11-27T17:24:52Z",
+                        "remaining": 50,
+                        "unit": "DAY",
+                        "value": 50,
+                        "verb": "POST"
+                    }
+                ],
+                "regex": "^/servers",
+                "uri": "*/servers"
+            },
+            {
+                "limit": [
+                    {
+                        "next-available": "2012-11-27T17:24:52Z",
+                        "remaining": 3,
+                        "unit": "MINUTE",
+                        "value": 3,
+                        "verb": "GET"
+                    }
+                ],
+                "regex": ".*changes-since.*",
+                "uri": "*changes-since*"
+            },
+            {
+                "limit": [
+                    {
+                        "next-available": "2012-11-27T17:24:52Z",
+                        "remaining": 12,
+                        "unit": "HOUR",
+                        "value": 12,
+                        "verb": "GET"
+                    }
+                ],
+                "regex": "^/os-fping",
+                "uri": "*/os-fping"
+            }
+        ]
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml b/doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml
new file mode 100644
index 000000000..c2b0572e5
--- /dev/null
+++ b/doc/api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml
@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<limits xmlns:os-used-limits="http://docs.openstack.org/compute/ext/used_limits/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/common/api/v1.0">
+  <rates>
+    <rate regex=".*" uri="*">
+      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="POST" remaining="10" value="10"/>
+      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="PUT" remaining="10" value="10"/>
+      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="DELETE" remaining="100" value="100"/>
+    </rate>
+    <rate regex="^/servers" uri="*/servers">
+      <limit next-available="2012-11-27T17:24:53Z" unit="DAY" verb="POST" remaining="50" value="50"/>
+    </rate>
+    <rate regex=".*changes-since.*" uri="*changes-since*">
+      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="GET" remaining="3" value="3"/>
+    </rate>
+    <rate regex="^/os-fping" uri="*/os-fping">
+      <limit next-available="2012-11-27T17:24:53Z" unit="HOUR" verb="GET" remaining="12" value="12"/>
+    </rate>
+  </rates>
+  <absolute>
+    <limit name="maxServerMeta" value="128"/>
+    <limit name="maxPersonality" value="5"/>
+    <limit name="maxImageMeta" value="128"/>
+    <limit name="maxPersonalitySize" value="10240"/>
+    <limit name="maxSecurityGroupRules" value="20"/>
+    <limit name="maxTotalKeypairs" value="100"/>
+    <limit name="totalRAMUsed" value="0"/>
+    <limit name="totalInstancesUsed" value="0"/>
+    <limit name="maxSecurityGroups" value="10"/>
+    <limit name="totalFloatingIpsUsed" value="0"/>
+    <limit name="maxTotalCores" value="20"/>
+    <limit name="totalSecurityGroupsUsed" value="0"/>
+    <limit name="maxTotalFloatingIps" value="10"/>
+    <limit name="maxTotalInstances" value="10"/>
+    <limit name="totalCoresUsed" value="0"/>
+    <limit name="maxTotalRAMSize" value="51200"/>
+  </absolute>
+</limits>
\ No newline at end of file
-- 
cgit