Puppet Class: heat

Defined in:
manifests/init.pp

Overview

Class: heat

Heat 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/virtual_host Defaults to $facts

control_exchange

(Optional) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. Defaults to $facts

rpc_response_timeout

(Optional) Configure the timeout (in seconds) for rpc responses Defaults to $facts.

executor_thread_pool_size

(Optional) Size of executor thread pool when executor is threading or eventlet. 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_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 $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_reconnect_delay

(Optional) How long to wait before reconnecting in response to an AMQP consumer cancel notification. (floating point value) 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_durable_queues

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

amqp_server_request_prefix

(Optional) Address prefix used when sending to a specific server Defaults to $facts.

amqp_broadcast_prefix

(Optional) address prefix used when broadcasting to all servers Defaults to $facts.

amqp_group_request_prefix

(Optional) address prefix when sending to any server in group Defaults to $facts.

amqp_container_name

(Optional) Name for the AMQP container Defaults to $facts.

amqp_idle_timeout

(Optional) Timeout for inactive connections Defaults to $facts.

amqp_trace

(Optional) Debug: dump AMQP frames to stdout Defaults to $facts.

amqp_ssl_ca_file

(Optional) CA certificate PEM file to verify server certificate Defaults to $facts.

amqp_ssl_cert_file

(Optional) Identifying certificate PEM file to present to clients Defaults to $facts.

amqp_ssl_key_file

(Optional) Private key PEM file used to sign cert_file certificate Defaults to $facts.

amqp_ssl_key_password

(Optional) Password for decrypting ssl_key_file (if encrypted) Defaults to $facts.

amqp_sasl_mechanisms

(Optional) Space separated list of acceptable SASL mechanisms Defaults to $facts.

amqp_sasl_config_dir

(Optional) Path to directory that contains the SASL configuration Defaults to $facts.

amqp_sasl_config_name

(Optional) Name of configuration file (without .conf suffix) Defaults to $facts.

amqp_username

(Optional) User name for message broker authentication Defaults to $facts.

amqp_password

(Optional) Password for message broker authentication Defaults to $facts.

host

(Optional) Name of this node. This is typically a hostname, FQDN, or IP address. Defaults to $facts.

max_template_size

(Optional) Maximum raw byte size of any template. Defaults to $facts

max_json_body_size

(Optional) Maximum raw byte size of JSON request body. Should be larger than max_template_size. 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

(Optional) Driver or drivers to handle sending notifications. Value can be a string or a list. Defaults to $facts

notification_topics

(optional) AMQP topic used for OpenStack notifications Defaults to facts

keystone_ec2_uri

(optional) Authentication Endpoint URI for ec2 service. Defaults to facts

flavor

(optional) Specifies the Authentication method. Set to ‘standalone’ to get Heat to work with a remote OpenStack Tested versions include 0.9 and 2.2 Defaults to $facts.

region_name

(Optional) Region name for services. This is the default region name that heat talks to service endpoints on. Defaults to $facts.

enable_stack_adopt

(Optional) Enable the stack-adopt feature. Defaults to $facts.

enable_stack_abandon

(Optional) Enable the stack-abandon feature. Defaults to $facts.

enable_proxy_headers_parsing

(Optional) Enable paste middleware to handle SSL requests through HTTPProxyToWSGI middleware. Defaults to $facts.

max_request_body_size

(Optional) Set max request body size Defaults to $facts.

purge_config

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

auth_strategy

(optional) Type of authentication to use Defaults to ‘keystone’

yaql_limit_iterators

(optional) The maximum number of elements YAQL collection expressions can

take for evaluation.

Defaults to $facts.

yaql_memory_quota

(optional) The maximum size of memory in bytes that YAQL expressions can

take for evaluation.

Defaults to $facts.

DEPRECATED PARAMETERS

heat_clients_url

(optional) Heat url in format like 0.0.0.0:8004/v1/%(tenant_id)s. Defaults to undef

heat_clients_endpoint_type

(optional) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. Defaults to undef

Parameters:

  • package_ensure (Any) (defaults to: 'present')
  • keystone_ec2_uri (Any) (defaults to: $facts['os_service_default'])
  • 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'])
  • 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_heartbeat_in_pthread (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_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_server_request_prefix (Any) (defaults to: $facts['os_service_default'])
  • amqp_broadcast_prefix (Any) (defaults to: $facts['os_service_default'])
  • amqp_group_request_prefix (Any) (defaults to: $facts['os_service_default'])
  • amqp_container_name (Any) (defaults to: $facts['os_service_default'])
  • amqp_idle_timeout (Any) (defaults to: $facts['os_service_default'])
  • amqp_trace (Any) (defaults to: $facts['os_service_default'])
  • amqp_ssl_ca_file (Any) (defaults to: $facts['os_service_default'])
  • amqp_ssl_cert_file (Any) (defaults to: $facts['os_service_default'])
  • amqp_ssl_key_file (Any) (defaults to: $facts['os_service_default'])
  • amqp_ssl_key_password (Any) (defaults to: $facts['os_service_default'])
  • amqp_sasl_mechanisms (Any) (defaults to: $facts['os_service_default'])
  • amqp_sasl_config_dir (Any) (defaults to: $facts['os_service_default'])
  • amqp_sasl_config_name (Any) (defaults to: $facts['os_service_default'])
  • amqp_username (Any) (defaults to: $facts['os_service_default'])
  • amqp_password (Any) (defaults to: $facts['os_service_default'])
  • host (Any) (defaults to: $facts['os_service_default'])
  • flavor (Any) (defaults to: $facts['os_service_default'])
  • region_name (Any) (defaults to: $facts['os_service_default'])
  • enable_stack_adopt (Any) (defaults to: $facts['os_service_default'])
  • enable_stack_abandon (Any) (defaults to: $facts['os_service_default'])
  • max_template_size (Any) (defaults to: $facts['os_service_default'])
  • max_json_body_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'])
  • enable_proxy_headers_parsing (Any) (defaults to: $facts['os_service_default'])
  • max_request_body_size (Any) (defaults to: $facts['os_service_default'])
  • purge_config (Any) (defaults to: false)
  • auth_strategy (Any) (defaults to: 'keystone')
  • yaql_memory_quota (Any) (defaults to: $facts['os_service_default'])
  • yaql_limit_iterators (Any) (defaults to: $facts['os_service_default'])
  • heat_clients_url (Any) (defaults to: undef)
  • heat_clients_endpoint_type (Any) (defaults to: undef)


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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'manifests/init.pp', line 254

class heat(
  $package_ensure                     = 'present',
  $keystone_ec2_uri                   = $facts['os_service_default'],
  $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'],
  $rabbit_ha_queues                   = $facts['os_service_default'],
  $rabbit_heartbeat_timeout_threshold = $facts['os_service_default'],
  $rabbit_heartbeat_rate              = $facts['os_service_default'],
  $rabbit_heartbeat_in_pthread        = $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_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_server_request_prefix         = $facts['os_service_default'],
  $amqp_broadcast_prefix              = $facts['os_service_default'],
  $amqp_group_request_prefix          = $facts['os_service_default'],
  $amqp_container_name                = $facts['os_service_default'],
  $amqp_idle_timeout                  = $facts['os_service_default'],
  $amqp_trace                         = $facts['os_service_default'],
  $amqp_ssl_ca_file                   = $facts['os_service_default'],
  $amqp_ssl_cert_file                 = $facts['os_service_default'],
  $amqp_ssl_key_file                  = $facts['os_service_default'],
  $amqp_ssl_key_password              = $facts['os_service_default'],
  $amqp_sasl_mechanisms               = $facts['os_service_default'],
  $amqp_sasl_config_dir               = $facts['os_service_default'],
  $amqp_sasl_config_name              = $facts['os_service_default'],
  $amqp_username                      = $facts['os_service_default'],
  $amqp_password                      = $facts['os_service_default'],
  $host                               = $facts['os_service_default'],
  $flavor                             = $facts['os_service_default'],
  $region_name                        = $facts['os_service_default'],
  $enable_stack_adopt                 = $facts['os_service_default'],
  $enable_stack_abandon               = $facts['os_service_default'],
  $max_template_size                  = $facts['os_service_default'],
  $max_json_body_size                 = $facts['os_service_default'],
  $notification_transport_url         = $facts['os_service_default'],
  $notification_driver                = $facts['os_service_default'],
  $notification_topics                = $facts['os_service_default'],
  $enable_proxy_headers_parsing       = $facts['os_service_default'],
  $max_request_body_size              = $facts['os_service_default'],
  $purge_config                       = false,
  $auth_strategy                      = 'keystone',
  $yaql_memory_quota                  = $facts['os_service_default'],
  $yaql_limit_iterators               = $facts['os_service_default'],
  # DEPRECATED PARAMETERS
  $heat_clients_url                   = undef,
  $heat_clients_endpoint_type         = undef,
) {

  include heat::db
  include heat::deps
  include heat::params

  if $auth_strategy == 'keystone' {
    include heat::keystone::authtoken
  }

  package { 'heat-common':
    ensure => $package_ensure,
    name   => $::heat::params::common_package_name,
    tag    => ['openstack', 'heat-package'],
  }

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

  oslo::messaging::rabbit { 'heat_config':
    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,
    kombu_reconnect_delay       => $kombu_reconnect_delay,
    kombu_failover_strategy     => $kombu_failover_strategy,
    kombu_compression           => $kombu_compression,
    heartbeat_timeout_threshold => $rabbit_heartbeat_timeout_threshold,
    heartbeat_rate              => $rabbit_heartbeat_rate,
    heartbeat_in_pthread        => $rabbit_heartbeat_in_pthread,
    rabbit_use_ssl              => $rabbit_use_ssl,
    amqp_durable_queues         => $amqp_durable_queues,
    rabbit_ha_queues            => $rabbit_ha_queues,
  }

  oslo::messaging::amqp { 'heat_config':
    server_request_prefix => $amqp_server_request_prefix,
    broadcast_prefix      => $amqp_broadcast_prefix,
    group_request_prefix  => $amqp_group_request_prefix,
    container_name        => $amqp_container_name,
    idle_timeout          => $amqp_idle_timeout,
    trace                 => $amqp_trace,
    ssl_ca_file           => $amqp_ssl_ca_file,
    ssl_cert_file         => $amqp_ssl_cert_file,
    ssl_key_file          => $amqp_ssl_key_file,
    ssl_key_password      => $amqp_ssl_key_password,
    sasl_mechanisms       => $amqp_sasl_mechanisms,
    sasl_config_dir       => $amqp_sasl_config_dir,
    sasl_config_name      => $amqp_sasl_config_name,
    username              => $amqp_username,
    password              => $amqp_password,
  }

  if !defined(Class[heat::trustee]) {
    warning('The heat:trustee class will be required to set trustee option in a future release')
    include heat::trustee
  }
  # TODO(tkajinam): Remove this when we remove the above logic
  heat_config {
    'trustee/project_domain_name': ensure => absent;
  }

  if $heat_clients_url != undef {
    warning('The heat_clients_url parameter is deprecated. Use the heat::clients::heat class.')
  }
  include heat::clients::heat

  if $heat_clients_endpoint_type!= undef {
    warning('The heat_clients_endpoint_type parameter is deprecated. Use the heat::clients class.')
  }
  include heat::clients

  if (!is_service_default($enable_stack_adopt)) {
    validate_legacy(Boolean, 'validate_bool', $enable_stack_adopt)
  }

  if (!is_service_default($enable_stack_abandon)) {
    validate_legacy(Boolean, 'validate_bool', $enable_stack_abandon)
  }

  heat_config {
    'DEFAULT/host':                         value => $host;
    'DEFAULT/max_template_size':            value => $max_template_size;
    'DEFAULT/max_json_body_size':           value => $max_json_body_size;
    'DEFAULT/region_name_for_services':     value => $region_name;
    'DEFAULT/enable_stack_abandon':         value => $enable_stack_abandon;
    'DEFAULT/enable_stack_adopt':           value => $enable_stack_adopt;
    'ec2authtoken/auth_uri':                value => $keystone_ec2_uri;
    'paste_deploy/flavor':                  value => $flavor;
    'yaql/limit_iterators':                 value => $yaql_limit_iterators;
    'yaql/memory_quota':                    value => $yaql_memory_quota;
  }

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

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

  oslo::middleware { 'heat_config':
    enable_proxy_headers_parsing => $enable_proxy_headers_parsing,
    max_request_body_size        => $max_request_body_size,
  }

}