Puppet Class: manila

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

Overview

Class: manila

Parameters

state_path

(optional) Directory for storing state. Defaults to ‘/var/lib/manila’

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) The default exchange under which topics are scope. Defaults to $facts

executor_thread_pool_size

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

package_ensure

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

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

(optional) Driver or drivers to handle sending notifications. Default to $facts

notification_topics

(optional) AMQP topics to publish to when using the RPC notification driver. (list value) Default 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_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.

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_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

amqp_durable_queues

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

amqp_auto_delete

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

use_ssl

(optional) Enable SSL on the API server Defaults to false

cert_file

(optional) Certificate file to use when starting API server securely Defaults to $facts.

key_file

(optional) Private key file to use when starting API server securely Defaults to $facts.

ca_file

(optional) CA certificate file to use to verify connecting clients Defaults to $facts.

api_paste_config

(Optional) Allow Configuration of /etc/manila/api-paste.ini.

storage_availability_zone

(optional) Availability zone of the node. Defaults to $facts

rootwrap_config

(optional) Path to the rootwrap configuration file to use for running commands as root

lock_path

(optional) Location to store Manila locks Defaults to $::manila::params::lock_path

purge_config

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

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

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

report_interval

(optional) Seconds between nodes reporting state to datastore. Defaults to $facts

periodic_interval

(optional) Seconds between running periodic tasks. Defaults to $facts

periodic_fuzzy_delay

(optional) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. Defaults to $facts.

service_down_time

(optional) Maximum time since last check-in for up service. 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'])
  • rabbit_heartbeat_timeout_threshold (Any) (defaults to: $facts['os_service_default'])
  • rabbit_heartbeat_rate (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_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'])
  • 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_failover_strategy (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'])
  • rabbit_qos_prefetch_count (Any) (defaults to: $facts['os_service_default'])
  • package_ensure (Any) (defaults to: 'present')
  • use_ssl (Boolean) (defaults to: false)
  • ca_file (Any) (defaults to: $facts['os_service_default'])
  • cert_file (Any) (defaults to: $facts['os_service_default'])
  • key_file (Any) (defaults to: $facts['os_service_default'])
  • api_paste_config (Any) (defaults to: '/etc/manila/api-paste.ini')
  • storage_availability_zone (Any) (defaults to: $facts['os_service_default'])
  • rootwrap_config (Any) (defaults to: '/etc/manila/rootwrap.conf')
  • state_path (Any) (defaults to: '/var/lib/manila')
  • lock_path (Any) (defaults to: $::manila::params::lock_path)
  • purge_config (Boolean) (defaults to: false)
  • host (Any) (defaults to: $facts['os_service_default'])
  • report_interval (Any) (defaults to: $facts['os_service_default'])
  • periodic_interval (Any) (defaults to: $facts['os_service_default'])
  • periodic_fuzzy_delay (Any) (defaults to: $facts['os_service_default'])
  • service_down_time (Any) (defaults to: $facts['os_service_default'])
  • rabbit_heartbeat_in_pthread (Any) (defaults to: undef)


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
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
# File 'manifests/init.pp', line 216

class manila (
  $default_transport_url              = $facts['os_service_default'],
  $rpc_response_timeout               = $facts['os_service_default'],
  $control_exchange                   = $facts['os_service_default'],
  $rabbit_heartbeat_timeout_threshold = $facts['os_service_default'],
  $rabbit_heartbeat_rate              = $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_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'],
  $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_failover_strategy            = $facts['os_service_default'],
  $amqp_durable_queues                = $facts['os_service_default'],
  $amqp_auto_delete                   = $facts['os_service_default'],
  $rabbit_qos_prefetch_count          = $facts['os_service_default'],
  $package_ensure                     = 'present',
  Boolean $use_ssl                    = false,
  $ca_file                            = $facts['os_service_default'],
  $cert_file                          = $facts['os_service_default'],
  $key_file                           = $facts['os_service_default'],
  $api_paste_config                   = '/etc/manila/api-paste.ini',
  $storage_availability_zone          = $facts['os_service_default'],
  $rootwrap_config                    = '/etc/manila/rootwrap.conf',
  $state_path                         = '/var/lib/manila',
  $lock_path                          = $::manila::params::lock_path,
  Boolean $purge_config               = false,
  $host                               = $facts['os_service_default'],
  $report_interval                    = $facts['os_service_default'],
  $periodic_interval                  = $facts['os_service_default'],
  $periodic_fuzzy_delay               = $facts['os_service_default'],
  $service_down_time                  = $facts['os_service_default'],
  # DEPRECATED PARAMETERS
  $rabbit_heartbeat_in_pthread        = undef,
) inherits manila::params {

  include manila::deps
  include manila::db

  if $use_ssl {
    if is_service_default($cert_file) {
      fail('The cert_file parameter is required when use_ssl is set to true')
    }
    if is_service_default($key_file) {
      fail('The key_file parameter is required when use_ssl is set to true')
    }
  }

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

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

  oslo::messaging::rabbit { 'manila_config':
    rabbit_use_ssl                  => $rabbit_use_ssl,
    amqp_durable_queues             => $amqp_durable_queues,
    amqp_auto_delete                => $amqp_auto_delete,
    rabbit_ha_queues                => $rabbit_ha_queues,
    kombu_ssl_ca_certs              => $kombu_ssl_ca_certs,
    kombu_ssl_certfile              => $kombu_ssl_certfile,
    kombu_ssl_keyfile               => $kombu_ssl_keyfile,
    kombu_ssl_version               => $kombu_ssl_version,
    kombu_failover_strategy         => $kombu_failover_strategy,
    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_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 { 'manila_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 { 'manila_config':
    transport_url => $notification_transport_url,
    driver        => $notification_driver,
    topics        => $notification_topics,
    retry         => $notification_retry,
  }

  manila_config {
    'DEFAULT/api_paste_config':          value => $api_paste_config;
    'DEFAULT/storage_availability_zone': value => $storage_availability_zone;
    'DEFAULT/rootwrap_config':           value => $rootwrap_config;
    'DEFAULT/state_path':                value => $state_path;
    'DEFAULT/host':                      value => $host;
    'DEFAULT/report_interval':           value => $report_interval;
    'DEFAULT/periodic_interval':         value => $periodic_interval;
    'DEFAULT/periodic_fuzzy_delay':      value => $periodic_fuzzy_delay;
    'DEFAULT/service_down_time':         value => $service_down_time;
  }

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

  # SSL Options
  if $use_ssl {
    oslo::service::ssl { 'manila_config':
      cert_file => $cert_file,
      key_file  => $key_file,
      ca_file   => $ca_file
    }
  } else {
    oslo::service::ssl { 'manila_config': }
  }
  # TODO(tkajinam): Remove this after 2025.1 release
  manila_config {
    'DEFAULT/ssl_cert_file': ensure => absent;
    'DEFAULT/ssl_key_file':  ensure => absent;
    'DEFAULT/ssl_ca_file':   ensure => absent;
  }
}