Puppet Class: heat::cache

Defined in:
manifests/cache.pp

Overview

Class heat::cache

heat 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 $facts

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 $facts

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 $facts

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 $facts

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 $facts

enabled

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

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 $facts

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 $facts

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 $facts

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 $facts

enable_socket_keepalive

(Optional) Global toggle for the socket keepalive of dogpile’s pymemcache backend Defaults to $facts

socket_keepalive_idle

(Optional) The time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes. Should be a positive integer most greater than zero. Defaults to $facts

socket_keepalive_interval

(Optional) The time (in seconds) between individual keepalive probes. Should be a positive integer most greater than zero. Defaults to $facts

socket_keepalive_count

(Optional) The maximum number of keepalive probes TCP should send before dropping the connection. Should be a positive integer most greater than zero. Defaults to $facts

memcache_pool_maxsize

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

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 $facts

memcache_pool_connection_get_timeout

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

manage_backend_package

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

constraint_validation_caching

(Optional) Enable caching in constraint validation. Global caching should be also enabled to enable this. Defaults to $facts

constraint_validation_expiration_time

(Optional) TTL, in seconds, for caching in constraint validation. Defaults to $facts

service_extension_caching

(Optional) Enable caching in service extension. Global caching should be also enabled to enable this. Defaults to $facts

service_extension_expiration_time

(Optional) TTL, in seconds, for caching in service extension. Defaults to $facts

resource_finder_caching

(Optional) Enable caching in resource finder. Global caching should be also enabled to enable this. Defaults to $facts

resource_finder_expiration_time

(Optional) TTL, in seconds, for caching in resource finder. Defaults to $facts

tls_enabled

(Optional) Global toggle for TLS usage when communicating with the caching servers. Default to $facts

tls_cafile

(Optional) Path to a file of concatenated CA certificates in PEM format necessary to establish the caching server’s authenticity. If tls_enabled is False, this option is ignored. Default to $facts

tls_certfile

(Optional) Path to a single file in PEM format containing the client’s certificate as well as any number of CA certificates needed to establish the certificate’s authenticity. This file is only required when client side authentication is necessary. If tls_enabled is False, this option is ignored. Default to $facts

tls_keyfile

(Optional) Path to a single file containing the client’s private key in. Otherwise the private key will be taken from the file specified in tls_certfile. If tls_enabled is False, this option is ignored. Default to $facts

tls_allowed_ciphers

(Optional) Set the available ciphers for sockets created with the TLS context. It should be a string in the OpenSSL cipher list format. If not specified, all OpenSSL enabled ciphers will be available. Default to $facts

enable_retry_client

(Optional) Enable retry client mechanisms to handle failure. Those mechanisms can be used to wrap all kind of pymemcache clients. The wrapper allows you to define how many attempts to make and how long to wait between attempts. Default to $facts

retry_attempts

(Optional) Number of times to attempt an action before failing. Default to $facts

retry_delay

(Optional) Number of seconds to sleep between each attempt. Default to $facts

hashclient_retry_attempts

(Optional) Amount of times a client should be tried before it is marked dead and removed from the pool in the HashClient’s internal mechanisms. Default to $facts

hashclient_retry_delay

(Optional) Time in seconds that should pass between retry attempts in the HashClient’s internal mechanisms. Default to $facts

dead_timeout

(Optional) Time in seconds before attempting to add a node back in the pool in the HashClient’s internal mechanisms. Default to $facts

Parameters:

  • config_prefix (Any) (defaults to: $facts['os_service_default'])
  • expiration_time (Any) (defaults to: $facts['os_service_default'])
  • backend (Any) (defaults to: $facts['os_service_default'])
  • backend_argument (Any) (defaults to: $facts['os_service_default'])
  • proxies (Any) (defaults to: $facts['os_service_default'])
  • enabled (Any) (defaults to: $facts['os_service_default'])
  • debug_cache_backend (Any) (defaults to: $facts['os_service_default'])
  • memcache_servers (Any) (defaults to: $facts['os_service_default'])
  • memcache_dead_retry (Any) (defaults to: $facts['os_service_default'])
  • memcache_socket_timeout (Any) (defaults to: $facts['os_service_default'])
  • enable_socket_keepalive (Any) (defaults to: $facts['os_service_default'])
  • socket_keepalive_idle (Any) (defaults to: $facts['os_service_default'])
  • socket_keepalive_interval (Any) (defaults to: $facts['os_service_default'])
  • socket_keepalive_count (Any) (defaults to: $facts['os_service_default'])
  • memcache_pool_maxsize (Any) (defaults to: $facts['os_service_default'])
  • memcache_pool_unused_timeout (Any) (defaults to: $facts['os_service_default'])
  • memcache_pool_connection_get_timeout (Any) (defaults to: $facts['os_service_default'])
  • manage_backend_package (Any) (defaults to: true)
  • constraint_validation_caching (Any) (defaults to: $facts['os_service_default'])
  • constraint_validation_expiration_time (Any) (defaults to: $facts['os_service_default'])
  • service_extension_caching (Any) (defaults to: $facts['os_service_default'])
  • service_extension_expiration_time (Any) (defaults to: $facts['os_service_default'])
  • resource_finder_caching (Any) (defaults to: $facts['os_service_default'])
  • resource_finder_expiration_time (Any) (defaults to: $facts['os_service_default'])
  • tls_enabled (Any) (defaults to: $facts['os_service_default'])
  • tls_cafile (Any) (defaults to: $facts['os_service_default'])
  • tls_certfile (Any) (defaults to: $facts['os_service_default'])
  • tls_keyfile (Any) (defaults to: $facts['os_service_default'])
  • tls_allowed_ciphers (Any) (defaults to: $facts['os_service_default'])
  • enable_retry_client (Any) (defaults to: $facts['os_service_default'])
  • retry_attempts (Any) (defaults to: $facts['os_service_default'])
  • retry_delay (Any) (defaults to: $facts['os_service_default'])
  • hashclient_retry_attempts (Any) (defaults to: $facts['os_service_default'])
  • hashclient_retry_delay (Any) (defaults to: $facts['os_service_default'])
  • dead_timeout (Any) (defaults to: $facts['os_service_default']) 


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'manifests/cache.pp', line 201

class heat::cache (
  $config_prefix                         = $facts['os_service_default'],
  $expiration_time                       = $facts['os_service_default'],
  $backend                               = $facts['os_service_default'],
  $backend_argument                      = $facts['os_service_default'],
  $proxies                               = $facts['os_service_default'],
  $enabled                               = $facts['os_service_default'],
  $debug_cache_backend                   = $facts['os_service_default'],
  $memcache_servers                      = $facts['os_service_default'],
  $memcache_dead_retry                   = $facts['os_service_default'],
  $memcache_socket_timeout               = $facts['os_service_default'],
  $enable_socket_keepalive               = $facts['os_service_default'],
  $socket_keepalive_idle                 = $facts['os_service_default'],
  $socket_keepalive_interval             = $facts['os_service_default'],
  $socket_keepalive_count                = $facts['os_service_default'],
  $memcache_pool_maxsize                 = $facts['os_service_default'],
  $memcache_pool_unused_timeout          = $facts['os_service_default'],
  $memcache_pool_connection_get_timeout  = $facts['os_service_default'],
  $manage_backend_package                = true,
  $constraint_validation_caching         = $facts['os_service_default'],
  $constraint_validation_expiration_time = $facts['os_service_default'],
  $service_extension_caching             = $facts['os_service_default'],
  $service_extension_expiration_time     = $facts['os_service_default'],
  $resource_finder_caching               = $facts['os_service_default'],
  $resource_finder_expiration_time       = $facts['os_service_default'],
  $tls_enabled                           = $facts['os_service_default'],
  $tls_cafile                            = $facts['os_service_default'],
  $tls_certfile                          = $facts['os_service_default'],
  $tls_keyfile                           = $facts['os_service_default'],
  $tls_allowed_ciphers                   = $facts['os_service_default'],
  $enable_retry_client                   = $facts['os_service_default'],
  $retry_attempts                        = $facts['os_service_default'],
  $retry_delay                           = $facts['os_service_default'],
  $hashclient_retry_attempts             = $facts['os_service_default'],
  $hashclient_retry_delay                = $facts['os_service_default'],
  $dead_timeout                          = $facts['os_service_default'],
) {

  include heat::deps

  oslo::cache { 'heat_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,
    enable_socket_keepalive              => $enable_socket_keepalive,
    socket_keepalive_idle                => $socket_keepalive_idle,
    socket_keepalive_interval            => $socket_keepalive_interval,
    socket_keepalive_count               => $socket_keepalive_count,
    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,
    tls_enabled                          => $tls_enabled,
    tls_cafile                           => $tls_cafile,
    tls_certfile                         => $tls_certfile,
    tls_keyfile                          => $tls_keyfile,
    tls_allowed_ciphers                  => $tls_allowed_ciphers,
    enable_retry_client                  => $enable_retry_client,
    retry_attempts                       => $retry_attempts,
    retry_delay                          => $retry_delay,
    hashclient_retry_attempts            => $hashclient_retry_attempts,
    hashclient_retry_delay               => $hashclient_retry_delay,
    dead_timeout                         => $dead_timeout,
  }

  heat_config {
    'constraint_validation_cache/caching':         value => $constraint_validation_caching;
    'constraint_validation_cache/expiration_time': value => $constraint_validation_expiration_time;
    'service_extension_cache/caching':             value => $service_extension_caching;
    'service_extension_cache/expiration_time':     value => $service_extension_expiration_time;
    'resource_finder_cache/caching':               value => $resource_finder_caching;
    'resource_finder_cache/expiration_time':       value => $resource_finder_expiration_time;
  }
}