From 3ab790a720b3ec1e894f09f0fdcdde7943f8728e Mon Sep 17 00:00:00 2001 From: Niall Bunting Date: Thu, 7 Jan 2016 16:07:08 +0000 Subject: [PATCH] Update the cache documentation This adds all the configuration options to the documentation. To make it easier in future to see what a user has control over. Change-Id: Ib68ccb793f68b05e7d9fd89bb91211206e33959a Closes-Bug: 1531906 --- doc/source/cache.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/source/cache.rst b/doc/source/cache.rst index 8a12fb54..62942e8f 100644 --- a/doc/source/cache.rst +++ b/doc/source/cache.rst @@ -34,6 +34,23 @@ requests to ``GET /images/``, the image cache is not automatically managed. Here, we describe the basics of how to manage the local image cache on Glance API servers and how to automate this cache management. +Configuration options for the Image Cache +----------------------------------------- + +The cache has a number of configuration options that are in the +configuration files. + +- ``image_cache_dir`` This is the base directory where Glance stores + the cache data. +- ``image_cache_sqlite_db`` Path to the sqlite file database that will + be used for cache manangement. +- ``image_cache_driver`` The driver used for cache management. (Likely + sqlite.) +- ``image_cache_max_size`` The size when the glance-cache-pruner will + remove the oldest images, to reduce the bytes until under this value. +- ``image_cache_stall_time`` The amount of time an incomplete image will + stay in the cache, after this the incomplete image will be deleted. + Controlling the Growth of the Image Cache ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~