openstack-manuals/doc/common/tables/keystone-cache.xml
Gauvain Pocentek 38a4da963d Generate config-ref tables for keystone
This patch imports the autogenerated tables for keystone. Actual use of
these tables will be done in another patch.

Change-Id: Ib035c8469820aca7a7cf880f1bea758e9ea855d1
Partial-Bug: #1277330
2014-04-14 21:30:22 +02:00

56 lines
3.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_keystone_cache">
<caption>Description of configuration options for cache</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[cache]</th>
</tr>
<tr>
<td>backend = keystone.common.cache.noop</td>
<td>(StrOpt) Dogpile.cache backend module. It is recommended that Memcache (dogpile.cache.memcache) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend.</td>
</tr>
<tr>
<td>backend_argument = []</td>
<td>(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "&lt;argname&gt;:&lt;value&gt;".</td>
</tr>
<tr>
<td>config_prefix = cache.keystone</td>
<td>(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.</td>
</tr>
<tr>
<td>debug_cache_backend = False</td>
<td>(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls) This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to False.</td>
</tr>
<tr>
<td>enabled = False</td>
<td>(BoolOpt) Global toggle for all caching using the should_cache_fn mechanism.</td>
</tr>
<tr>
<td>expiration_time = 600</td>
<td>(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it.</td>
</tr>
<tr>
<td>proxies = </td>
<td>(ListOpt) Proxy Classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. Comma delimited list e.g. my.dogpile.proxy.Class, my.dogpile.proxyClass2.</td>
</tr>
<tr>
<td>use_key_mangler = True</td>
<td>(BoolOpt) Use a key-mangling function (sha1) to ensure fixed length cache-keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to True.</td>
</tr>
</tbody>
</table>
</para>