Puppet Class: cinder

Inherits:
cinder::params
Defined in:
manifests/init.pp

Overview

Class: cinder

Cinder base package & configuration

Parameters

package_ensure

(Optional) Ensure state for package. Defaults to ‘present’

default_transport_url

(optional) A URL representing the messaging driver to use and its full configuration. Transport URLs take the form:

transport://user:pass@host1:port[,hostN:portN]/virtual_host

Defaults to $facts

rpc_response_timeout

(optional) Seconds to wait for a response from a call Defaults to $facts

control_exchange

(Optional) Defaults to $facts

executor_thread_pool_size

(Optional) Size of executor thread pool when executor is threading or eventlet. Defaults to $facts.

notification_transport_url

(Optional) A URL representing the messaging driver to use for notifications and its full configuration. Transport URLs take the form:

transport://user:pass@host1:port[,hostN:portN]/virtual_host

Defaults to $facts

notification_driver

(Option) Driver or drivers to handle sending notifications. Defaults to $facts

notification_topics

(Optional) AMQP topic used for OpenStack notifications Defaults to $facts

notification_retry

(Optional) The maximum number of attempts to re-sent a notification message, which failed to be delivered due to a recoverable error. Defaults to $facts.

rabbit_ha_queues

(optional) Use HA queues in RabbitMQ (x-ha-policy: all). Defaults to $facts

rabbit_heartbeat_timeout_threshold

(optional) Number of seconds after which the RabbitMQ broker is considered down if the heartbeat keepalive fails. Any value >0 enables heartbeats. Heartbeating helps to ensure the TCP connection to RabbitMQ isn’t silently closed, resulting in missed or lost messages from the queue. (Requires kombu >= 3.0.7 and amqp >= 1.4.0) Defaults to $facts

rabbit_heartbeat_rate

(optional) How often during the rabbit_heartbeat_timeout_threshold period to check the heartbeat on RabbitMQ connection. (i.e. rabbit_heartbeat_rate=2 when rabbit_heartbeat_timeout_threshold=60, the heartbeat will be checked every 30 seconds. Defaults to $facts

rabbit_qos_prefetch_count

(Optional) Specifies the number of messages to prefetch. Defaults to $facts

rabbit_quorum_queue

(Optional) Use quorum queues in RabbitMQ. Defaults to $facts

rabbit_transient_quorum_queue

(Optional) Use quorum queues for transients queues in RabbitMQ. Defaults to $facts

rabbit_transient_queues_ttl

(Optional) Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues. (integer value) Min to 1 Defaults to $facts

rabbit_quorum_delivery_limit

(Optional) Each time a message is rdelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered. Defaults to $facts

rabbit_quorum_max_memory_length

(Optional) Limit the number of messages in the quorum queue. Defaults to $facts

rabbit_quorum_max_memory_bytes

(Optional) Limit the number of memory bytes used by the quorum queue. Defaults to $facts

rabbit_enable_cancel_on_failover

(Optional) Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumers when queue is down. Defaults to $facts

rabbit_use_ssl

(optional) Connect over SSL for RabbitMQ Defaults to $facts

report_interval

(optional) Interval, in seconds, between nodes reporting state to datastore (integer value). Defaults to $facts

service_down_time

(optional) Maximum time since last check-in for a service to be considered up (integer value). Defaults to $facts

kombu_ssl_ca_certs

(optional) SSL certification authority file (valid only if SSL enabled). Defaults to $facts

kombu_ssl_certfile

(optional) SSL cert file (valid only if SSL enabled). Defaults to $facts

kombu_ssl_keyfile

(optional) SSL key file (valid only if SSL enabled). Defaults to $facts

kombu_ssl_version

(optional) SSL version to use (valid only if SSL enabled). Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions. Defaults to $facts

kombu_reconnect_delay

(optional) How long to wait before reconnecting in response to an AMQP consumer cancel notification. Defaults to $facts

kombu_failover_strategy

(Optional) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. (string value) Defaults to $facts

kombu_compression

(optional) Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. EXPERIMENTAL. (string value) Defaults to $facts

amqp_auto_delete

(Optional) Define if transient queues should be auto-deleted (boolean value) Defaults to $facts

amqp_durable_queues

Use durable queues in amqp. (Optional) Defaults to $facts

storage_availability_zone

(optional) Availability zone of the node. Defaults to ‘nova’

default_availability_zone

(optional) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. Defaults to undef

allow_availability_zone_fallback

(optional) Allow availability zone fallback if preferred availability zone cannot be deployed to. Defaults to $facts

api_paste_config

(Optional) Defaults to ‘/etc/cinder/api-paste.ini’,

lock_path

(optional) Where to store lock files. This directory must be writeable by the user executing the agent Defaults to: $::cinder::params::lock_path

image_conversion_dir

(optional) Location to store temporary image files if the volume driver does not write them directly to the volume and the volume conversion needs to be performed. Defaults to $facts

image_compress_on_upload

(optional) When possible, compress images uploaded to the image service. Defaults to $facts

image_conversion_cpu_limit

(optional) CPU time limit in seconds to convert the image. Defaults to $facts

image_conversion_address_space_limit

(optional) Address space limit in gigabytes to convert the image. Defaults to $facts

image_conversion_disable

(optional) Disallow image conversion when creating a volume from an image and when uploading a volume as an image. Defaults to $facts

host

(optional) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. Defaults to $facts.

enable_new_services

(optional) Services to be added to the available pool on create. Defaults to $facts

purge_config

(optional) Whether to set only the specified config options in the cinder config. Defaults to false.

enable_force_upload

(optional) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. Defaults to $facts.

cinder_internal_tenant_project_id

(optional) ID of the project which will be used as the Cinder internal tenant. Defaults to $facts.

cinder_internal_tenant_user_id

(optional) ID of the user to be used in volume operations as the Cinder internal tenant. Defaults to $facts.

DEPRECATED PARAMETERS

rabbit_heartbeat_in_pthread

(Optional) EXPERIMENTAL: Run the health check heartbeat thread through a native python thread. By default if this option isn’t provided the health check heartbeat will inherit the execution model from the parent process. By example if the parent process have monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. Defaults to undef.

Parameters:

  • default_transport_url (Any) (defaults to: $facts['os_service_default'])
  • rpc_response_timeout (Any) (defaults to: $facts['os_service_default'])
  • control_exchange (Any) (defaults to: $facts['os_service_default'])
  • executor_thread_pool_size (Any) (defaults to: $facts['os_service_default'])
  • notification_transport_url (Any) (defaults to: $facts['os_service_default'])
  • notification_driver (Any) (defaults to: $facts['os_service_default'])
  • notification_topics (Any) (defaults to: $facts['os_service_default'])
  • notification_retry (Any) (defaults to: $facts['os_service_default'])
  • rabbit_ha_queues (Any) (defaults to: $facts['os_service_default'])
  • rabbit_heartbeat_timeout_threshold (Any) (defaults to: $facts['os_service_default'])
  • rabbit_heartbeat_rate (Any) (defaults to: $facts['os_service_default'])
  • rabbit_qos_prefetch_count (Any) (defaults to: $facts['os_service_default'])
  • rabbit_quorum_queue (Any) (defaults to: $facts['os_service_default'])
  • rabbit_transient_quorum_queue (Any) (defaults to: $facts['os_service_default'])
  • rabbit_transient_queues_ttl (Any) (defaults to: $facts['os_service_default'])
  • rabbit_quorum_delivery_limit (Any) (defaults to: $facts['os_service_default'])
  • rabbit_quorum_max_memory_length (Any) (defaults to: $facts['os_service_default'])
  • rabbit_quorum_max_memory_bytes (Any) (defaults to: $facts['os_service_default'])
  • rabbit_enable_cancel_on_failover (Any) (defaults to: $facts['os_service_default'])
  • rabbit_use_ssl (Any) (defaults to: $facts['os_service_default'])
  • service_down_time (Any) (defaults to: $facts['os_service_default'])
  • report_interval (Any) (defaults to: $facts['os_service_default'])
  • kombu_ssl_ca_certs (Any) (defaults to: $facts['os_service_default'])
  • kombu_ssl_certfile (Any) (defaults to: $facts['os_service_default'])
  • kombu_ssl_keyfile (Any) (defaults to: $facts['os_service_default'])
  • kombu_ssl_version (Any) (defaults to: $facts['os_service_default'])
  • kombu_reconnect_delay (Any) (defaults to: $facts['os_service_default'])
  • kombu_failover_strategy (Any) (defaults to: $facts['os_service_default'])
  • kombu_compression (Any) (defaults to: $facts['os_service_default'])
  • amqp_durable_queues (Any) (defaults to: $facts['os_service_default'])
  • amqp_auto_delete (Any) (defaults to: $facts['os_service_default'])
  • package_ensure (Any) (defaults to: 'present')
  • api_paste_config (Any) (defaults to: '/etc/cinder/api-paste.ini')
  • storage_availability_zone (Any) (defaults to: $facts['os_service_default'])
  • default_availability_zone (Any) (defaults to: $facts['os_service_default'])
  • allow_availability_zone_fallback (Any) (defaults to: $facts['os_service_default'])
  • lock_path (Any) (defaults to: $::cinder::params::lock_path)
  • image_conversion_dir (Any) (defaults to: $facts['os_service_default'])
  • image_compress_on_upload (Any) (defaults to: $facts['os_service_default'])
  • image_conversion_cpu_limit (Any) (defaults to: $facts['os_service_default'])
  • image_conversion_address_space_limit (Any) (defaults to: $facts['os_service_default'])
  • image_conversion_disable (Any) (defaults to: $facts['os_service_default'])
  • host (Any) (defaults to: $facts['os_service_default'])
  • enable_new_services (Any) (defaults to: $facts['os_service_default'])
  • purge_config (Boolean) (defaults to: false)
  • enable_force_upload (Any) (defaults to: $facts['os_service_default'])
  • cinder_internal_tenant_project_id (Any) (defaults to: $facts['os_service_default'])
  • cinder_internal_tenant_user_id (Any) (defaults to: $facts['os_service_default'])
  • rabbit_heartbeat_in_pthread (Any) (defaults to: undef)


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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'manifests/init.pp', line 251

class cinder (
  $default_transport_url                = $facts['os_service_default'],
  $rpc_response_timeout                 = $facts['os_service_default'],
  $control_exchange                     = $facts['os_service_default'],
  $executor_thread_pool_size            = $facts['os_service_default'],
  $notification_transport_url           = $facts['os_service_default'],
  $notification_driver                  = $facts['os_service_default'],
  $notification_topics                  = $facts['os_service_default'],
  $notification_retry                   = $facts['os_service_default'],
  $rabbit_ha_queues                     = $facts['os_service_default'],
  $rabbit_heartbeat_timeout_threshold   = $facts['os_service_default'],
  $rabbit_heartbeat_rate                = $facts['os_service_default'],
  $rabbit_qos_prefetch_count            = $facts['os_service_default'],
  $rabbit_quorum_queue                  = $facts['os_service_default'],
  $rabbit_transient_quorum_queue        = $facts['os_service_default'],
  $rabbit_transient_queues_ttl          = $facts['os_service_default'],
  $rabbit_quorum_delivery_limit         = $facts['os_service_default'],
  $rabbit_quorum_max_memory_length      = $facts['os_service_default'],
  $rabbit_quorum_max_memory_bytes       = $facts['os_service_default'],
  $rabbit_enable_cancel_on_failover     = $facts['os_service_default'],
  $rabbit_use_ssl                       = $facts['os_service_default'],
  $service_down_time                    = $facts['os_service_default'],
  $report_interval                      = $facts['os_service_default'],
  $kombu_ssl_ca_certs                   = $facts['os_service_default'],
  $kombu_ssl_certfile                   = $facts['os_service_default'],
  $kombu_ssl_keyfile                    = $facts['os_service_default'],
  $kombu_ssl_version                    = $facts['os_service_default'],
  $kombu_reconnect_delay                = $facts['os_service_default'],
  $kombu_failover_strategy              = $facts['os_service_default'],
  $kombu_compression                    = $facts['os_service_default'],
  $amqp_durable_queues                  = $facts['os_service_default'],
  $amqp_auto_delete                     = $facts['os_service_default'],
  $package_ensure                       = 'present',
  $api_paste_config                     = '/etc/cinder/api-paste.ini',
  $storage_availability_zone            = $facts['os_service_default'],
  $default_availability_zone            = $facts['os_service_default'],
  $allow_availability_zone_fallback     = $facts['os_service_default'],
  $lock_path                            = $::cinder::params::lock_path,
  $image_conversion_dir                 = $facts['os_service_default'],
  $image_compress_on_upload             = $facts['os_service_default'],
  $image_conversion_cpu_limit           = $facts['os_service_default'],
  $image_conversion_address_space_limit = $facts['os_service_default'],
  $image_conversion_disable             = $facts['os_service_default'],
  $host                                 = $facts['os_service_default'],
  $enable_new_services                  = $facts['os_service_default'],
  Boolean $purge_config                 = false,
  $enable_force_upload                  = $facts['os_service_default'],
  $cinder_internal_tenant_project_id    = $facts['os_service_default'],
  $cinder_internal_tenant_user_id       = $facts['os_service_default'],
  # DEPRECATED PARAMETERS
  $rabbit_heartbeat_in_pthread          = undef,
) inherits cinder::params {

  include cinder::deps
  include cinder::db

  package { 'cinder':
    ensure => $package_ensure,
    name   => $::cinder::params::package_name,
    tag    => ['openstack', 'cinder-package'],
  }

  resources { 'cinder_config':
    purge => $purge_config,
  }

  oslo::messaging::rabbit { 'cinder_config':
    rabbit_ha_queues                => $rabbit_ha_queues,
    heartbeat_timeout_threshold     => $rabbit_heartbeat_timeout_threshold,
    heartbeat_rate                  => $rabbit_heartbeat_rate,
    heartbeat_in_pthread            => $rabbit_heartbeat_in_pthread,
    rabbit_qos_prefetch_count       => $rabbit_qos_prefetch_count,
    rabbit_use_ssl                  => $rabbit_use_ssl,
    kombu_reconnect_delay           => $kombu_reconnect_delay,
    kombu_failover_strategy         => $kombu_failover_strategy,
    kombu_ssl_version               => $kombu_ssl_version,
    kombu_ssl_keyfile               => $kombu_ssl_keyfile,
    kombu_ssl_certfile              => $kombu_ssl_certfile,
    kombu_ssl_ca_certs              => $kombu_ssl_ca_certs,
    amqp_durable_queues             => $amqp_durable_queues,
    amqp_auto_delete                => $amqp_auto_delete,
    kombu_compression               => $kombu_compression,
    rabbit_quorum_queue             => $rabbit_quorum_queue,
    rabbit_transient_quorum_queue   => $rabbit_transient_quorum_queue,
    rabbit_transient_queues_ttl     => $rabbit_transient_queues_ttl,
    rabbit_quorum_delivery_limit    => $rabbit_quorum_delivery_limit,
    rabbit_quorum_max_memory_length => $rabbit_quorum_max_memory_length,
    rabbit_quorum_max_memory_bytes  => $rabbit_quorum_max_memory_bytes,
    enable_cancel_on_failover       => $rabbit_enable_cancel_on_failover,
  }

  oslo::messaging::default { 'cinder_config':
    executor_thread_pool_size => $executor_thread_pool_size,
    transport_url             => $default_transport_url,
    rpc_response_timeout      => $rpc_response_timeout,
    control_exchange          => $control_exchange,
  }

  oslo::messaging::notifications { 'cinder_config':
    transport_url => $notification_transport_url,
    driver        => $notification_driver,
    topics        => $notification_topics,
    retry         => $notification_retry,
  }

  cinder_config {
    'DEFAULT/report_interval':                      value => $report_interval;
    'DEFAULT/service_down_time':                    value => $service_down_time;
    'DEFAULT/api_paste_config':                     value => $api_paste_config;
    'DEFAULT/storage_availability_zone':            value => $storage_availability_zone;
    'DEFAULT/default_availability_zone':            value => $default_availability_zone;
    'DEFAULT/allow_availability_zone_fallback':     value => $allow_availability_zone_fallback;
    'DEFAULT/image_conversion_dir':                 value => $image_conversion_dir;
    'DEFAULT/image_compress_on_upload':             value => $image_compress_on_upload;
    'DEFAULT/image_conversion_cpu_limit':           value => $image_conversion_cpu_limit;
    'DEFAULT/image_conversion_address_space_limit': value => $image_conversion_address_space_limit;
    'DEFAULT/image_conversion_disable':             value => $image_conversion_disable;
    'DEFAULT/host':                                 value => $host;
    'DEFAULT/enable_new_services':                  value => $enable_new_services;
    'DEFAULT/enable_force_upload':                  value => $enable_force_upload;
    'DEFAULT/cinder_internal_tenant_project_id':    value => $cinder_internal_tenant_project_id;
    'DEFAULT/cinder_internal_tenant_user_id':       value => $cinder_internal_tenant_user_id;
  }

  oslo::concurrency { 'cinder_config':
    lock_path => $lock_path
  }
}