Files
puppet-neutron/manifests/init.pp
Nathan A. Taylor b467edb2a3 Add purge_config option for all configs
Adding a purge_config option for all configs (specifically left out
services/lbaas.pp and services/vpnaas.pp as they require default
entries). Adding this option for ease of management and readability.
If users wish, they can use this to ensure that only the options they
are setting make it into the configs.
  *rebased my changes

Change-Id: I2286acb350ae6300f2e4c8dd320f2534ddf09bf9
2016-04-13 13:48:09 -06:00

535 lines
20 KiB
Puppet

# == Class: neutron
#
# Installs the neutron package and configures
# /etc/neutron/neutron.conf
#
# === Parameters:
#
# [*enabled*]
# (required) Whether or not to enable the neutron service
# true/false
#
# [*package_ensure*]
# (optional) The state of the package
# Defaults to 'present'
#
# [*verbose*]
# (optional) Verbose logging
# Defaults to $::os_service_default
#
# [*debug*]
# (optional) Print debug messages in the logs
# Defaults to $::os_service_default
#
# [*bind_host*]
# (optional) The IP/interface to bind to
# Defaults to $::os_service_default
#
# [*bind_port*]
# (optional) The port to use
# Defaults to $::os_service_default
#
# [*core_plugin*]
# (optional) Neutron plugin provider
# Defaults to openvswitch
# Could be bigswitch, brocade, cisco, embrane, hyperv, linuxbridge, midonet, ml2, mlnx, nec, nicira, plumgrid, ryu, nuage, opencontrail (full path)
#
# Example for opencontrail:
#
# class {'neutron' :
# core_plugin => 'neutron.plugins.opencontrail.contrail_plugin:NeutronPluginContrailCoreV2'
# }
#
# [*service_plugins*]
# (optional) Advanced service modules.
# Could be an array that can have these elements:
# router, firewall, lbaas, vpnaas, metering, qos
# Defaults to $::os_service_default
#
# [*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 $::os_service_default
#
# [*mac_generation_retries*]
# (optional) How many times to try to generate a unique mac
# Defaults to $::os_service_default
#
# [*dhcp_lease_duration*]
# (optional) DHCP lease
# Defaults to $::os_service_default
#
# [*dns_domain*]
# (optional) Domain to use for building the hostnames
# Defaults to $::os_service_default
#
# [*dhcp_agents_per_network*]
# (optional) Number of DHCP agents scheduled to host a network.
# This enables redundant DHCP agents for configured networks.
# Defaults to $::os_service_default
#
# [*global_physnet_mtu*]
# (optional) The MTU size for the interfaces managed by neutron
# Defaults to $::os_service_default
#
# [*dhcp_agent_notification*]
# (optional) Allow sending resource operation notification to DHCP agent.
# Defaults to $::os_service_default
#
# [*advertise_mtu*]
# (optional) VMs will receive DHCP and RA MTU option when the network's preferred MTU is known
# Defaults to $::os_service_default
#
# [*allow_bulk*]
# (optional) Enable bulk crud operations
# Defaults to $::os_service_default
#
# [*allow_pagination*]
# (optional) Enable pagination
# Defaults to $::os_service_default
#
# [*allow_sorting*]
# (optional) Enable sorting
# Defaults to $::os_service_default
#
# [*allow_overlapping_ips*]
# (optional) Enables network namespaces
# Defaults to $::os_service_default
#
# [*api_extensions_path*]
# (optional) Specify additional paths for API extensions that the
# module in use needs to load.
# Defaults to $::os_service_default
#
# [*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'.
#
# [*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: $::os_service_default
#
# [*memcache_servers*]
# List of memcache servers in format of server:port.
# Optional. Defaults to false. Example: ['localhost:11211']
#
# [*control_exchange*]
# (optional) What RPC queue/exchange to use
# Defaults to neutron
# [*rpc_backend*]
# (optional) what rpc/queuing service to use
# Defaults to rabbit (rabbitmq)
#
# [*rpc_response_timeout*]
# (optional) Seconds to wait for a response from a call
# Defaults to $::os_service_default
#
# [*rabbit_password*]
# [*rabbit_host*]
# [*rabbit_port*]
# [*rabbit_user*]
# (optional) Various rabbitmq settings
#
# [*rabbit_virtual_host*]
# (optional) virtualhost to use.
# Defaults to $::os_service_default
#
# [*rabbit_hosts*]
# (optional) array of rabbitmq servers for HA.
# A single IP address, such as a VIP, can be used for load-balancing
# multiple RabbitMQ Brokers.
# Defaults to false
#
# [*rabbit_ha_queues*]
# (Optional) Use HA queues in RabbitMQ.
# Defaults to undef
#
# [*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 0
#
# [*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 2
#
# [*rabbit_use_ssl*]
# (optional) Connect over SSL for RabbitMQ
# Defaults to $::os_service_default
#
# [*amqp_durable_queues*]
# (optional) Define queues as "durable" to rabbitmq.
# Defaults to $::os_service_default
#
# [*kombu_ssl_ca_certs*]
# (optional) SSL certification authority file (valid only if SSL enabled).
# Defaults to $::os_service_default
#
# [*kombu_ssl_certfile*]
# (optional) SSL cert file (valid only if SSL enabled).
# Defaults to $::os_service_default
#
# [*kombu_ssl_keyfile*]
# (optional) SSL key file (valid only if SSL enabled).
# Defaults to $::os_service_default
#
# [*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 'TLSv1'
#
# [*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 propery premote the master before attempting to
# reconnect. See https://review.openstack.org/#/c/76686
# Defaults to $::os_service_default
#
# [*use_ssl*]
# (optinal) Enable SSL on the API server
# Defaults to $::os_service_default
#
# [*cert_file*]
# (optinal) certificate file to use when starting api server securely
# defaults to $::os_service_default
#
# [*key_file*]
# (optional) Private key file to use when starting API server securely
# Defaults to $::os_service_default
#
# [*ca_file*]
# (optional) CA certificate file to use to verify connecting clients
# Defaults to $::os_service_default
#
# [*use_syslog*]
# (optional) Use syslog for logging
# Defaults to $::os_service_default
#
# [*use_stderr*]
# (optional) Use stderr for logging
# Defaults to $::os_service_default
#
# [*log_facility*]
# (optional) Syslog facility to receive log lines
# Defaults to $::os_service_default
#
# [*log_file*]
# (optional) Where to log
# Defaults to false
#
# [*log_dir*]
# (optional) Directory where logs should be stored
# If set to boolean false, it will not log to any directory
# Defaults to /var/log/neutron
#
# [*state_path*]
# (optional) Where to store state files. This directory must be writable
# by the user executing the agent
# Defaults to: $::os_service_default
#
# [*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.
#
# DEPRECATED PARAMETERS
#
# [*qpid_hostname*]
# [*qpid_port*]
# [*qpid_username*]
# [*qpid_password*]
# [*qpid_heartbeat*]
# [*qpid_protocol*]
# [*qpid_tcp_nodelay*]
# [*qpid_reconnect*]
# [*qpid_reconnect_timeout*]
# [*qpid_reconnect_limit*]
# [*qpid_reconnect_interval*]
# [*qpid_reconnect_interval_min*]
# [*qpid_reconnect_interval_max*]
# [*network_device_mtu*]
#
class neutron (
$enabled = true,
$package_ensure = 'present',
$verbose = $::os_service_default,
$debug = $::os_service_default,
$bind_host = $::os_service_default,
$bind_port = $::os_service_default,
$core_plugin = 'openvswitch',
$service_plugins = $::os_service_default,
$auth_strategy = 'keystone',
$base_mac = $::os_service_default,
$mac_generation_retries = $::os_service_default,
$dhcp_lease_duration = $::os_service_default,
$dns_domain = $::os_service_default,
$dhcp_agents_per_network = $::os_service_default,
$global_physnet_mtu = $::os_service_default,
$dhcp_agent_notification = $::os_service_default,
$advertise_mtu = $::os_service_default,
$allow_bulk = $::os_service_default,
$allow_pagination = $::os_service_default,
$allow_sorting = $::os_service_default,
$allow_overlapping_ips = $::os_service_default,
$api_extensions_path = $::os_service_default,
$root_helper = 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf',
$report_interval = $::os_service_default,
$memcache_servers = false,
$control_exchange = 'neutron',
$rpc_backend = 'rabbit',
$rpc_response_timeout = $::os_service_default,
$rabbit_password = false,
$rabbit_host = 'localhost',
$rabbit_hosts = false,
$rabbit_port = 5672,
$rabbit_ha_queues = undef,
$rabbit_user = 'guest',
$rabbit_virtual_host = $::os_service_default,
$rabbit_heartbeat_timeout_threshold = 0,
$rabbit_heartbeat_rate = 2,
$rabbit_use_ssl = $::os_service_default,
$amqp_durable_queues = $::os_service_default,
$kombu_ssl_ca_certs = $::os_service_default,
$kombu_ssl_certfile = $::os_service_default,
$kombu_ssl_keyfile = $::os_service_default,
$kombu_ssl_version = 'TLSv1',
$kombu_reconnect_delay = $::os_service_default,
$use_ssl = $::os_service_default,
$cert_file = $::os_service_default,
$key_file = $::os_service_default,
$ca_file = $::os_service_default,
$use_syslog = $::os_service_default,
$use_stderr = $::os_service_default,
$log_facility = $::os_service_default,
$log_file = false,
$log_dir = '/var/log/neutron',
$state_path = $::os_service_default,
$lock_path = '$state_path/lock',
$purge_config = false,
# DEPRECATED PARAMETERS
$qpid_hostname = undef,
$qpid_port = undef,
$qpid_username = undef,
$qpid_password = undef,
$qpid_heartbeat = undef,
$qpid_protocol = undef,
$qpid_tcp_nodelay = undef,
$qpid_reconnect = undef,
$qpid_reconnect_timeout = undef,
$qpid_reconnect_limit = undef,
$qpid_reconnect_interval_min = undef,
$qpid_reconnect_interval_max = undef,
$qpid_reconnect_interval = undef,
$network_device_mtu = undef,
) {
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')
}
}
if ! is_service_default($use_ssl) and !($use_ssl) {
if ! is_service_default($ca_file) and ($ca_file) {
fail('The ca_file parameter requires that use_ssl to be set to true')
}
}
if ! is_service_default($rabbit_use_ssl) and !($rabbit_use_ssl) {
if ! is_service_default($kombu_ssl_ca_certs) and ($kombu_ssl_ca_certs) {
fail('The kombu_ssl_ca_certs parameter requires rabbit_use_ssl to be set to true')
}
if ! is_service_default($kombu_ssl_certfile) and ($kombu_ssl_certfile) {
fail('The kombu_ssl_certfile parameter requires rabbit_use_ssl to be set to true')
}
if ! is_service_default($kombu_ssl_keyfile) and ($kombu_ssl_keyfile) {
fail('The kombu_ssl_keyfile parameter requires rabbit_use_ssl to be set to true')
}
}
if (is_service_default($kombu_ssl_certfile) and ! is_service_default($kombu_ssl_keyfile)) or (is_service_default($kombu_ssl_keyfile) and ! is_service_default($kombu_ssl_certfile)) {
fail('The kombu_ssl_certfile and kombu_ssl_keyfile parameters must be used together')
}
if $memcache_servers {
validate_array($memcache_servers)
}
package { 'neutron':
ensure => $package_ensure,
name => $::neutron::params::package_name,
tag => ['openstack', 'neutron-package'],
}
# Make sure all services get restarted if neutron-common package is upgraded
Package['neutron'] ~> Service<| tag == 'neutron-service' |>
resources { 'neutron_config':
purge => $purge_config,
}
neutron_config {
'DEFAULT/verbose': value => $verbose;
'DEFAULT/debug': value => $debug;
'DEFAULT/use_stderr': value => $use_stderr;
'DEFAULT/use_syslog': value => $use_syslog;
'DEFAULT/syslog_log_facility': value => $log_facility;
'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/mac_generation_retries': value => $mac_generation_retries;
'DEFAULT/dhcp_lease_duration': value => $dhcp_lease_duration;
'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/advertise_mtu': value => $advertise_mtu;
'DEFAULT/allow_bulk': value => $allow_bulk;
'DEFAULT/allow_pagination': value => $allow_pagination;
'DEFAULT/allow_sorting': value => $allow_sorting;
'DEFAULT/allow_overlapping_ips': value => $allow_overlapping_ips;
'DEFAULT/control_exchange': value => $control_exchange;
'DEFAULT/rpc_backend': value => $rpc_backend;
'DEFAULT/api_extensions_path': value => $api_extensions_path;
'DEFAULT/state_path': value => $state_path;
'DEFAULT/rpc_response_timeout': value => $rpc_response_timeout;
'DEFAULT/global_physnet_mtu': value => pick($network_device_mtu, $global_physnet_mtu);
'oslo_concurrency/lock_path': value => $lock_path;
'agent/root_helper': value => $root_helper;
'agent/report_interval': value => $report_interval;
}
if $log_file {
neutron_config {
'DEFAULT/log_file': value => $log_file;
'DEFAULT/log_dir': value => $log_dir;
}
} else {
if $log_dir {
neutron_config {
'DEFAULT/log_dir': value => $log_dir;
'DEFAULT/log_file': ensure => absent;
}
} else {
neutron_config {
'DEFAULT/log_dir': ensure => absent;
'DEFAULT/log_file': ensure => absent;
}
}
}
if ! is_service_default ($service_plugins) and ($service_plugins) {
if is_array($service_plugins) {
neutron_config { 'DEFAULT/service_plugins': value => join($service_plugins, ',') }
} else {
fail('service_plugins should be an array.')
}
}
if $memcache_servers {
neutron_config {
'DEFAULT/memcached_servers': value => join($memcache_servers, ',');
}
} else {
neutron_config {
'DEFAULT/memcached_servers': ensure => absent;
}
}
if $rpc_backend == 'rabbit' or $rpc_backend == 'neutron.openstack.common.rpc.impl_kombu' {
if ! $rabbit_password {
fail('When rpc_backend is rabbitmq, you must set rabbit password')
}
if $rabbit_hosts {
neutron_config { 'oslo_messaging_rabbit/rabbit_hosts': value => join($rabbit_hosts, ',') }
} else {
neutron_config { 'oslo_messaging_rabbit/rabbit_host': value => $rabbit_host }
neutron_config { 'oslo_messaging_rabbit/rabbit_port': value => $rabbit_port }
neutron_config { 'oslo_messaging_rabbit/rabbit_hosts': value => "${rabbit_host}:${rabbit_port}" }
}
if $rabbit_ha_queues == undef {
if $rabbit_hosts {
neutron_config { 'oslo_messaging_rabbit/rabbit_ha_queues': value => true }
} else {
neutron_config { 'oslo_messaging_rabbit/rabbit_ha_queues': value => false }
}
} else {
neutron_config { 'oslo_messaging_rabbit/rabbit_ha_queues': value => $rabbit_ha_queues }
}
neutron_config {
'oslo_messaging_rabbit/rabbit_userid': value => $rabbit_user;
'oslo_messaging_rabbit/rabbit_password': value => $rabbit_password, secret => true;
'oslo_messaging_rabbit/rabbit_virtual_host': value => $rabbit_virtual_host;
'oslo_messaging_rabbit/heartbeat_timeout_threshold': value => $rabbit_heartbeat_timeout_threshold;
'oslo_messaging_rabbit/heartbeat_rate': value => $rabbit_heartbeat_rate;
'oslo_messaging_rabbit/rabbit_use_ssl': value => $rabbit_use_ssl;
'oslo_messaging_rabbit/kombu_reconnect_delay': value => $kombu_reconnect_delay;
'oslo_messaging_rabbit/kombu_ssl_ca_certs': value => $kombu_ssl_ca_certs;
'oslo_messaging_rabbit/kombu_ssl_certfile': value => $kombu_ssl_certfile;
'oslo_messaging_rabbit/kombu_ssl_keyfile': value => $kombu_ssl_keyfile;
'oslo_messaging_rabbit/amqp_durable_queues': value => $amqp_durable_queues;
}
if ! is_service_default($rabbit_use_ssl) and ($rabbit_use_ssl) {
if $kombu_ssl_version {
neutron_config { 'oslo_messaging_rabbit/kombu_ssl_version': value => $kombu_ssl_version; }
} else {
neutron_config { 'oslo_messaging_rabbit/kombu_ssl_version': ensure => absent; }
}
} else {
neutron_config {
'oslo_messaging_rabbit/kombu_ssl_version': ensure => absent;
}
}
}
if $rpc_backend == 'qpid' or $rpc_backend == 'neutron.openstack.common.rpc.impl_qpid' {
warning('Qpid driver is removed from Oslo.messaging in the Mitaka release')
}
if $network_device_mtu {
warning('The neutron::network_device_mtu parameter is deprecated, use neutron::global_physnet_mtu instead.')
}
# SSL Options
neutron_config {
'DEFAULT/use_ssl': value => $use_ssl;
'ssl/cert_file': value => $cert_file;
'ssl/key_file': value => $key_file;
'ssl/ca_file': value => $ca_file;
}
}