From 40f477bd6c9bd4b486df156db2f7bc70caa62419 Mon Sep 17 00:00:00 2001
From: Stuart McLaren <stuart.mclaren@hp.com>
Date: Fri, 22 Mar 2013 11:40:46 +0000
Subject: [PATCH] Add image_size_cap documentation

Add documentation for the 'image_size_cap' parameter.

Addresses bug 1158723.

Change-Id: If6d28a3837dc875b7c8e3e18dd5058eb07b40638
---
 doc/source/configuring.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/source/configuring.rst b/doc/source/configuring.rst
index da88fa73b7..cd9ec3bdbe 100644
--- a/doc/source/configuring.rst
+++ b/doc/source/configuring.rst
@@ -316,6 +316,21 @@ Can only be specified in configuration files.
 Sets the storage backend to use by default when storing images in Glance.
 Available options for this option are (``file``, ``swift``, ``s3``, or ``rbd``).
 
+Configuring Glance Image Size Limit
+-----------------------------------
+
+The following configuration option is specified in the
+``glance-api.conf`` config file in the section ``[DEFAULT]``.
+
+* ``image_size_cap=SIZE``
+
+Optional. Default: ``1099511627776`` (1 TB)
+
+Maximum image size, in bytes, which can be uploaded through the Glance API server.
+
+**IMPORTANT NOTE**: this value should only be increased after careful consideration
+and must be set to a value under 8 EB (9223372036854775808).
+
 Configuring the Filesystem Storage Backend
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~