← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nova/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/source/api_ext/ext_quotas.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-05-24 13:12:53 UTC
  • mfrom: (1.1.55)
  • Revision ID: package-import@ubuntu.com-20120524131253-ommql08fg1en06ut
Tags: 2012.2~f1-0ubuntu1
https://launchpad.net/bugs/907197
* New upstream release.
* Prepare for quantal:
  - Dropped debian/patches/upstream/0006-Use-project_id-in-ec2.cloud._format_image.patch
  - Dropped debian/patches/upstream/0005-Populate-image-properties-with-project_id-again.patch
  - Dropped debian/patches/upstream/0004-Fixed-bug-962840-added-a-test-case.patch
  - Dropped debian/patches/upstream/0003-Allow-unprivileged-RADOS-users-to-access-rbd-volumes.patch
  - Dropped debian/patches/upstream/0002-Stop-libvirt-test-from-deleting-instances-dir.patch
  - Dropped debian/patches/upstream/0001-fix-bug-where-nova-ignores-glance-host-in-imageref.patch 
  - Dropped debian/patches/0001-fix-useexisting-deprecation-warnings.patch
* debian/control: Add python-keystone as a dependency. (LP: #907197)
* debian/patches/kombu_tests_timeout.patch: Refreshed.
* debian/nova.conf, debian/nova-common.postinst: Convert to new ini
  file configuration
* debian/patches/nova-manage_flagfile_location.patch: Refreshed

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/api_ext/ext_quotas.rst
1
 
The Quotas Extension
2
 
=================================================================
3
 
About this Extension
4
 
--------------------
5
 
The quotas extension enables limiters placed on the resources used per tenant (project) for virtual instances. It is used with the OpenStack Compute API 1.1 for administrators who need to control the amount of volumes, memory, floating IP addresses, instances, or cores allowed within a defined tenant or project.
6
 
 
7
 
To use this extension, you need to have administrative rights to the tenants upon which you are placing quotas.
8
 
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
9
 
 
10
 
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://mycloud.com/v1.1/tenant/extensions.
11
 
 
12
 
Extension Overview
13
 
~~~~~~~~~~~~~~~~~~
14
 
Name
15
 
        Quotas
16
 
        
17
 
Namespace
18
 
        http://docs.openstack.org/ext/quotas-sets/api/v1.1
19
 
 
20
 
Alias
21
 
        OPS-QUO
22
 
        
23
 
Contact
24
 
        Name <jake@markupisart.com>
25
 
        
26
 
Status
27
 
        Alpha
28
 
        
29
 
Extension Version
30
 
        v1.0 (2011-08-16)
31
 
 
32
 
Dependencies
33
 
        Compute API 1.1
34
 
        
35
 
Doc Link (PDF)
36
 
        http://
37
 
        
38
 
Doc Link (WADL)
39
 
        http://
40
 
        
41
 
Short Description
42
 
        This extension enables quota management for OpenStack Compute servers so that resources for virtual instances are properly managed.
43
 
 
44
 
Sample Query Responses
45
 
~~~~~~~~~~~~~~~~~~~~~~
46
 
 
47
 
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
48
 
 
49
 
Extension Query Response: XML::
50
 
 
51
 
    TBD
52
 
 
53
 
.. todo:: Provide example of extension query XML response.
54
 
 
55
 
Extension Query Response: JSON::
56
 
 
57
 
{"extensions": [{"updated": "2011-08-08T00:00:00+00:00", "name": "Quotas", "links": [], "namespace": "http://docs.openstack.org/ext/quotas-sets/api/v1.1", "alias": "os-quota-sets", "description": "Quotas management support"}]}
58
 
 
59
 
Document Change History
60
 
~~~~~~~~~~~~~~~~~~~~~~~
61
 
 
62
 
============= =====================================
63
 
Revision Date Summary of Changes
64
 
2011-09-14    Initial draft
65
 
2012-03-30    Reformat of content
66
 
============= =====================================
67
 
 
68
 
 
69
 
Summary of Changes
70
 
------------------
71
 
This extension to the OpenStack Compute API allows administrators to control quotas for tenants (formerly known as projects).
72
 
 
73
 
This support is provided by the addition of new <actions, faults, headers, resources, states, something else>.
74
 
 
75
 
New Actions
76
 
~~~~~~~~~~~
77
 
List the actions each in a section. Enter "None" if there are no changes.
78
 
 
79
 
Include the response codes, transitions if applicable, and XML and JSON examples.
80
 
 
81
 
New Faults
82
 
~~~~~~~~~~
83
 
 
84
 
New Headers
85
 
~~~~~~~~~~~
86
 
 
87
 
New Resources
88
 
~~~~~~~~~~~~~
89
 
 
90
 
New States
91
 
~~~~~~~~~~
92
 
 
93
 
Changes to the Cloud Servers Specification
94
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
 
 
96
 
List the specific changes to the API. For example:
97
 
 
98
 
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
99
 
 
100
 
Provide examples in XML and JSON