openstack-manuals/doc/user-guide-admin/section_cli_cinder_quotas.xml
Brad Lodgen 6cb6da81c7 Provide References for Cinder Quota Defaults
The documentation currently does not reference what the cinder quota
default values are or where they are found.

Adds documentation covering which file the values are found in,
where in the file they are found, and a link to a sample cinder config
file so users can quickly find which values exist in the default config.

Change-Id: Ie8ebe52764951b5907f0c40997251176fa8e023a
Closes-Bug: #1374156
2015-01-20 12:28:33 -06:00

141 lines
5.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="cli_set_block_storage_quotas">
<title>Manage Block Storage service quotas</title>
<para>As an administrative user, you can update the OpenStack Block
Storage service quotas for a project. You can also update the quota
defaults for a new project.</para>
<para>
<table rules="all">
<caption>Block Storage quotas</caption>
<col width="20%"/>
<col width="80%"/>
<thead>
<tr>
<th>Property name</th>
<th>Defines the number of</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<para>gigabytes</para>
</td>
<td>
<para>Volume gigabytes allowed for each
tenant.</para>
</td>
</tr>
<tr>
<td>
<para>snapshots</para>
</td>
<td>
<para>Volume snapshots allowed for each
tenant.</para>
</td>
</tr>
<tr>
<td>
<para>volumes</para>
</td>
<td>
<para>Volumes allowed for each tenant.</para>
</td>
</tr>
</tbody>
</table>
</para>
<section xml:id="cli_view_block_storage_quotas">
<title>View Block Storage quotas</title>
<para>Administrative users can view Block Storage
service quotas.</para>
<procedure>
<step>
<para>List the default quotas for all projects:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-defaults <replaceable>TENANT_ID</replaceable></userinput>
<computeroutput>+-----------+-------+
| Property | Value |
+-----------+-------+
| gigabytes | 1000 |
| snapshots | 10 |
| volumes | 10 |
+-----------+-------+</computeroutput></screen>
</step>
<step>
<para>View Block Storage service quotas for a project:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-show <replaceable>TENANT_NAME</replaceable></userinput></screen>
<para>For example:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-show tenant01</userinput>
<computeroutput>+-----------+-------+
| Property | Value |
+-----------+-------+
| gigabytes | 1000 |
| snapshots | 10 |
| volumes | 10 |
+-----------+-------+</computeroutput></screen>
</step>
<step>
<para>Show the current usage of a per-tenant quota:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-usage <replaceable>tenantID</replaceable></userinput>
<computeroutput>+-----------+--------+----------+-------+
| Type | In_use | Reserved | Limit |
+-----------+--------+----------+-------+
| gigabytes | 0 | 0 | 1000 |
| snapshots | 0 | 0 | 10 |
| volumes | 0 | 0 | 15 |
+-----------+--------+----------+-------+</computeroutput></screen>
</step>
</procedure>
</section>
<section xml:id="cli_edit_update_block_storage_quotas">
<title>Edit and Update Block Storage service quotas</title>
<para>Administrative users can edit and update Block Storage
service quotas.</para>
<procedure>
<step>
<para>Clear per-tenant quota limits:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-delete <replaceable>tenantID</replaceable></userinput></screen>
</step>
<step>
<para>To update a default value for a new project,
update the property in the <literal>cinder.quota</literal> section of the
<filename>/etc/cinder/cinder.conf</filename>
file. For more information,
see the <link
xlink:href="http://docs.openstack.org/trunk/config-reference/content/ch_configuring-openstack-block-storage.html"
>Block Storage Configuration Reference</link>.</para>
</step>
<step>
<para>To update Block Storage service quotas, place
the tenant ID in a variable:</para>
<screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen>
</step>
<step>
<para>Update a particular quota value:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-update --<replaceable>quotaName</replaceable> <replaceable>NewValue</replaceable> <replaceable>tenantID</replaceable></userinput></screen>
<para>For example:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-update --volumes 15 $tenant</userinput>
<prompt>$</prompt> <userinput>cinder quota-show tenant01</userinput>
<computeroutput>+-----------+-------+
| Property | Value |
+-----------+-------+
| gigabytes | 1000 |
| snapshots | 10 |
| volumes | 15 |
+-----------+-------+</computeroutput></screen>
</step>
<step>
<para>Clear per-tenant quota limits:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-delete <replaceable>tenantID</replaceable></userinput></screen>
</step>
</procedure>
</section>
</section>