..
    Warning: Do not edit this file. It is automatically generated from the
    software project's code and your changes will be overwritten.

    The tool to generate this file lives in openstack-doc-tools repository.

    Please make any changes needed in the code, then run the
    autogenerate-config-doc tool from the openstack-doc-tools repository, or
    ask for help on the documentation mailing list, IRC channel or meeting.

.. _nova-cache:

.. list-table:: Description of cache configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description

   * - ``config_prefix`` = ``cache.oslo``

     - (String) 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.

   * - ``backend_argument`` = ``[]``

     - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>".

   * - ``memcache_dead_retry`` = ``300``

     - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).

   * - ``enabled`` = ``False``

     - (Boolean) Global toggle for caching.

   * - ``memcache_socket_timeout`` = ``3``

     - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).

   * - ``memcache_servers`` = ``localhost:11211``

     - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).

   * - ``memcache_pool_unused_timeout`` = ``60``

     - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only).

   * - ``debug_cache_backend`` = ``False``

     - (Boolean) 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.

   * - ``expiration_time`` = ``600``

     - (Integer) 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.

   * - ``proxies`` =

     - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.

   * - ``memcache_pool_maxsize`` = ``10``

     - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only).

   * - ``memcache_pool_connection_get_timeout`` = ``10``

     - (Integer) Number of seconds that an operation will wait to get a memcache client connection.

   * - ``backend`` = ``dogpile.cache.null``

     - (String) Dogpile.cache backend module. It is recommended that Memcache or Redis (dogpile.cache.redis) be used in production deployments. For eventlet-based or highly threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For low thread servers, dogpile.cache.memcached is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend.