openstack-manuals/doc/common/tables/keystone-cache.xml
Gauvain Pocentek b88212e062 config reference update for juno-1
Generate the config tables with the autohelp script and include the new
tables in the config ref sections.

For consistency, use the 'database' and 'auth_token' keywords in all
projects.

Split the LBaaS tables.

Closes-Bug: #1327802
Closes-Bug: #1331180
Closes-Bug: #1331175
Closes-Bug: #1330279
Closes-Bug: #1323946
Closes-Bug: #1323437
Closes-Bug: #1322075
Closes-Bug: #1321621
Closes-Bug: #1319564
Closes-Bug: #1318081
Closes-Bug: #1311474
Change-Id: I5602dda76fdf929d9124f5aa67d31ca4ac17c6d5
2014-06-29 20:55:34 +02:00

55 lines
2.8 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<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.memcached) 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.</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>