Puppet Class: nova::cache

Defined in:
manifests/cache.pp

Overview

Class nova::cache

nova cache configuration

parameters

config_prefix

(Optional) 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. (string value) Defaults to $::os_service_default

expiration_time

(Optional) 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. (integer value) Defaults to $::os_service_default

backend

(Optional) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. (string value) Defaults to $::os_service_default

backend_argument

(Optional) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: “<argname>:<value>”. (list value) Defaults to $::os_service_default

proxies

(Optional) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. (list value) Defaults to $::os_service_default

enabled

(Optional) Global toggle for caching. (boolean value) Defaults to $::os_service_default

debug_cache_backend

(Optional) 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. (boolean value) Defaults to $::os_service_default

memcache_servers

(Optional) Memcache servers in the format of “host:port”. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). (list value) Defaults to $::os_service_default

memcache_dead_retry

(Optional) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). (integer value) Defaults to $::os_service_default

memcache_socket_timeout

(Optional) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). (floating point value) Defaults to $::os_service_default

memcache_pool_maxsize

(Optional) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). (integer value) Defaults to $::os_service_default

memcache_pool_unused_timeout

(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only) (integer value) Defaults to $::os_service_default

memcache_pool_connection_get_timeout

(Optional) Number of seconds that an operation will wait to get a memcache client connection. (integer value) Defaults to $::os_service_default

manage_backend_package

(Optional) (Optional) Whether to install the backend package for the cache. Defaults to true

Parameters:

  • config_prefix (Any) (defaults to: $::os_service_default)
  • expiration_time (Any) (defaults to: $::os_service_default)
  • backend (Any) (defaults to: $::os_service_default)
  • backend_argument (Any) (defaults to: $::os_service_default)
  • proxies (Any) (defaults to: $::os_service_default)
  • enabled (Any) (defaults to: $::os_service_default)
  • debug_cache_backend (Any) (defaults to: $::os_service_default)
  • memcache_servers (Any) (defaults to: $::os_service_default)
  • memcache_dead_retry (Any) (defaults to: $::os_service_default)
  • memcache_socket_timeout (Any) (defaults to: $::os_service_default)
  • memcache_pool_maxsize (Any) (defaults to: $::os_service_default)
  • memcache_pool_unused_timeout (Any) (defaults to: $::os_service_default)
  • memcache_pool_connection_get_timeout (Any) (defaults to: $::os_service_default)
  • manage_backend_package (Any) (defaults to: true) 


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'manifests/cache.pp', line 88

class nova::cache (
  $config_prefix                        = $::os_service_default,
  $expiration_time                      = $::os_service_default,
  $backend                              = $::os_service_default,
  $backend_argument                     = $::os_service_default,
  $proxies                              = $::os_service_default,
  $enabled                              = $::os_service_default,
  $debug_cache_backend                  = $::os_service_default,
  $memcache_servers                     = $::os_service_default,
  $memcache_dead_retry                  = $::os_service_default,
  $memcache_socket_timeout              = $::os_service_default,
  $memcache_pool_maxsize                = $::os_service_default,
  $memcache_pool_unused_timeout         = $::os_service_default,
  $memcache_pool_connection_get_timeout = $::os_service_default,
  $manage_backend_package               = true,
) {

  include nova::deps

  oslo::cache { 'nova_config':
    config_prefix                        => $config_prefix,
    expiration_time                      => $expiration_time,
    backend                              => $backend,
    backend_argument                     => $backend_argument,
    proxies                              => $proxies,
    enabled                              => $enabled,
    debug_cache_backend                  => $debug_cache_backend,
    memcache_servers                     => $memcache_servers,
    memcache_dead_retry                  => $memcache_dead_retry,
    memcache_socket_timeout              => $memcache_socket_timeout,
    memcache_pool_maxsize                => $memcache_pool_maxsize,
    memcache_pool_unused_timeout         => $memcache_pool_unused_timeout,
    memcache_pool_connection_get_timeout => $memcache_pool_connection_get_timeout,
    manage_backend_package               => $manage_backend_package,
  }
}