Puppet Class: neutron

Defined in:
manifests/init.pp

Overview

Class: neutron

Installs the neutron package and configures /etc/neutron/neutron.conf

Parameters:

package_ensure

(optional) The state of the package Defaults to ‘present’

bind_host

(optional) The IP/interface to bind to Defaults to $facts

bind_port

(optional) The port to use Defaults to $facts

core_plugin

(optional) Neutron plugin provider Defaults to ml2

service_plugins

(optional) Advanced service modules. Could be an array that can have these elements: router, firewall, vpnaas, metering, qos Defaults to $facts

auth_strategy

(optional) How to authenticate Defaults to ‘keystone’. ‘noauth’ and ‘keystone’ are the only valid options

base_mac

(optional) The MAC address pattern to use. Defaults to $facts

dhcp_lease_duration

(optional) DHCP lease Defaults to $facts

host

(optional) Hostname to be used by the server, agents and services. Defaults to $facts

dns_domain

(optional) Domain to use for building the hostnames Defaults to $facts

dhcp_agents_per_network

(optional) Number of DHCP agents scheduled to host a network. This enables redundant DHCP agents for configured networks. Defaults to $facts

global_physnet_mtu

(optional) The MTU size for the interfaces managed by neutron Defaults to $facts

dhcp_agent_notification

(optional) Allow sending resource operation notification to DHCP agent. Defaults to $facts

allow_bulk

(optional) Enable bulk crud operations Defaults to $facts

api_extensions_path

(optional) Specify additional paths for API extensions that the module in use needs to load. Defaults to $facts

root_helper

(optional) Use “sudo neutron-rootwrap /etc/neutron/rootwrap.conf” to use the real root filter facility. Change to “sudo” to skip the filtering and just run the command directly Defaults to ‘sudo neutron-rootwrap /etc/neutron/rootwrap.conf’.

root_helper_daemon

(optional) Root helper daemon application to use when possible. Defaults to $facts.

report_interval

(optional) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. agent_down_time is a config for neutron-server, set by class neutron::server report_interval is a config for neutron agents, set by class neutron Defaults to: $facts

control_exchange

(optional) What RPC queue/exchange to use Defaults to $facts

executor_thread_pool_size

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

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

rabbit_ha_queues

(Optional) Use HA queues in RabbitMQ. 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_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

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. Defaults to $facts

amqp_auto_delete

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

amqp_durable_queues

(optional) Define queues as “durable” to 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) The amount of time to wait before attempting to reconnect to MQ provider. This is used in some cases where you may need to wait for the provider to properly promote the master before attempting to reconnect. See review.opendev.org/#/c/76686 Defaults to $facts

kombu_missing_consumer_retry_timeout

(Optional) How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. (integer 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

use_ssl

(optional) Enable SSL on the API server Defaults to $facts

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

state_path

(optional) Where to store state files. This directory must be writable by the user executing the agent Defaults to: $facts

lock_path

(optional) Where to store lock files. This directory must be writeable by the user executing the agent Defaults to: ‘$state_path/lock’

purge_config

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

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

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.

max_allowed_address_pair

(optional) Maximum number of allowed address pairs per port Defaults to $facts.

vlan_transparent

(optional) Allow plugins that support it to create VLAN transparent networks. Defaults to $facts.

vlan_qinq

(optional) Allow plugins that support it to create VLAN transparent networks using 0x8a88 ethertype. 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:

  • package_ensure (Any) (defaults to: 'present')
  • bind_host (Any) (defaults to: $facts['os_service_default'])
  • bind_port (Any) (defaults to: $facts['os_service_default'])
  • core_plugin (Any) (defaults to: 'ml2')
  • service_plugins (Any) (defaults to: $facts['os_service_default'])
  • auth_strategy (Any) (defaults to: 'keystone')
  • base_mac (Any) (defaults to: $facts['os_service_default'])
  • dhcp_lease_duration (Any) (defaults to: $facts['os_service_default'])
  • host (Any) (defaults to: $facts['os_service_default'])
  • dns_domain (Any) (defaults to: $facts['os_service_default'])
  • dhcp_agents_per_network (Any) (defaults to: $facts['os_service_default'])
  • global_physnet_mtu (Any) (defaults to: $facts['os_service_default'])
  • dhcp_agent_notification (Any) (defaults to: $facts['os_service_default'])
  • allow_bulk (Any) (defaults to: $facts['os_service_default'])
  • api_extensions_path (Any) (defaults to: $facts['os_service_default'])
  • root_helper (Any) (defaults to: 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf')
  • root_helper_daemon (Any) (defaults to: $facts['os_service_default'])
  • report_interval (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'])
  • default_transport_url (Any) (defaults to: $facts['os_service_default'])
  • rpc_response_timeout (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_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'])
  • rabbit_transient_queues_ttl (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'])
  • 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_missing_consumer_retry_timeout (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'])
  • use_ssl (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'])
  • ca_file (Any) (defaults to: $facts['os_service_default'])
  • state_path (Any) (defaults to: $facts['os_service_default'])
  • lock_path (Any) (defaults to: '$state_path/lock')
  • purge_config (Boolean) (defaults to: false)
  • 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'])
  • max_allowed_address_pair (Any) (defaults to: $facts['os_service_default'])
  • vlan_transparent (Any) (defaults to: $facts['os_service_default'])
  • vlan_qinq (Any) (defaults to: $facts['os_service_default'])
  • rabbit_heartbeat_in_pthread (Any) (defaults to: undef) 


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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'manifests/init.pp', line 296

class neutron (
  $package_ensure                       = 'present',
  $bind_host                            = $facts['os_service_default'],
  $bind_port                            = $facts['os_service_default'],
  $core_plugin                          = 'ml2',
  $service_plugins                      = $facts['os_service_default'],
  $auth_strategy                        = 'keystone',
  $base_mac                             = $facts['os_service_default'],
  $dhcp_lease_duration                  = $facts['os_service_default'],
  $host                                 = $facts['os_service_default'],
  $dns_domain                           = $facts['os_service_default'],
  $dhcp_agents_per_network              = $facts['os_service_default'],
  $global_physnet_mtu                   = $facts['os_service_default'],
  $dhcp_agent_notification              = $facts['os_service_default'],
  $allow_bulk                           = $facts['os_service_default'],
  $api_extensions_path                  = $facts['os_service_default'],
  $root_helper                          = 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf',
  $root_helper_daemon                   = $facts['os_service_default'],
  $report_interval                      = $facts['os_service_default'],
  $control_exchange                     = $facts['os_service_default'],
  $executor_thread_pool_size            = $facts['os_service_default'],
  $default_transport_url                = $facts['os_service_default'],
  $rpc_response_timeout                 = $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_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'],
  $rabbit_transient_queues_ttl          = $facts['os_service_default'],
  $amqp_durable_queues                  = $facts['os_service_default'],
  $amqp_auto_delete                     = $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_missing_consumer_retry_timeout = $facts['os_service_default'],
  $kombu_failover_strategy              = $facts['os_service_default'],
  $kombu_compression                    = $facts['os_service_default'],
  $use_ssl                              = $facts['os_service_default'],
  $cert_file                            = $facts['os_service_default'],
  $key_file                             = $facts['os_service_default'],
  $ca_file                              = $facts['os_service_default'],
  $state_path                           = $facts['os_service_default'],
  $lock_path                            = '$state_path/lock',
  Boolean $purge_config                 = false,
  $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'],
  $max_allowed_address_pair             = $facts['os_service_default'],
  $vlan_transparent                     = $facts['os_service_default'],
  $vlan_qinq                            = $facts['os_service_default'],
  # DEPRECATED PARAMETERS
  $rabbit_heartbeat_in_pthread          = undef,
) {

  include neutron::deps
  include neutron::params

  if ! is_service_default($use_ssl) and ($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 { 'neutron':
    ensure => $package_ensure,
    name   => $::neutron::params::package_name,
    tag    => ['openstack', 'neutron-package'],
  }

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

  neutron_config {
    'DEFAULT/bind_host':                value => $bind_host;
    'DEFAULT/bind_port':                value => $bind_port;
    'DEFAULT/auth_strategy':            value => $auth_strategy;
    'DEFAULT/core_plugin':              value => $core_plugin;
    'DEFAULT/base_mac':                 value => $base_mac;
    'DEFAULT/dhcp_lease_duration':      value => $dhcp_lease_duration;
    'DEFAULT/host':                     value => $host;
    'DEFAULT/dns_domain':               value => $dns_domain;
    'DEFAULT/dhcp_agents_per_network':  value => $dhcp_agents_per_network;
    'DEFAULT/dhcp_agent_notification':  value => $dhcp_agent_notification;
    'DEFAULT/allow_bulk':               value => $allow_bulk;
    'DEFAULT/api_extensions_path':      value => $api_extensions_path;
    'DEFAULT/state_path':               value => $state_path;
    'DEFAULT/global_physnet_mtu':       value => $global_physnet_mtu;
    'DEFAULT/max_allowed_address_pair': value => $max_allowed_address_pair;
    'DEFAULT/vlan_transparent':         value => $vlan_transparent;
    'DEFAULT/vlan_qinq':                value => $vlan_qinq;
    'agent/root_helper':                value => $root_helper;
    'agent/root_helper_daemon':         value => $root_helper_daemon;
    'agent/report_interval':            value => $report_interval;
  }

  oslo::messaging::default { 'neutron_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::concurrency { 'neutron_config': lock_path => $lock_path }

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

  neutron_config {
    'DEFAULT/service_plugins': value => join(any2array($service_plugins), ',')
  }

  oslo::messaging::rabbit {'neutron_config':
    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,
    rabbit_transient_queues_ttl          => $rabbit_transient_queues_ttl,
    kombu_reconnect_delay                => $kombu_reconnect_delay,
    kombu_missing_consumer_retry_timeout => $kombu_missing_consumer_retry_timeout,
    kombu_failover_strategy              => $kombu_failover_strategy,
    kombu_compression                    => $kombu_compression,
    kombu_ssl_ca_certs                   => $kombu_ssl_ca_certs,
    kombu_ssl_certfile                   => $kombu_ssl_certfile,
    kombu_ssl_keyfile                    => $kombu_ssl_keyfile,
    amqp_durable_queues                  => $amqp_durable_queues,
    amqp_auto_delete                     => $amqp_auto_delete,
    rabbit_ha_queues                     => $rabbit_ha_queues,
    kombu_ssl_version                    => $kombu_ssl_version,
    rabbit_quorum_queue                  => $rabbit_quorum_queue,
    rabbit_transient_quorum_queue        => $rabbit_transient_quorum_queue,
    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,
  }

  # SSL Options
  neutron_config {
    'DEFAULT/use_ssl': value => $use_ssl;
  }
  oslo::service::ssl { 'neutron_config':
    cert_file => $cert_file,
    key_file  => $key_file,
    ca_file   => $ca_file,
  }

}