Puppet Class: neutron::agents::dhcp

Defined in:
manifests/agents/dhcp.pp

Overview

Class: neutron::agents::dhcp

Setups Neutron DHCP agent.

Parameters

package_ensure

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

enabled

(optional) Enable state for service. Defaults to ‘true’.

manage_service

(optional) Whether to start/stop the service Defaults to true

debug

(optional) Show debugging output in log. Defaults to $::os_service_default.

state_path

(optional) Where to store dnsmasq state files. This directory must be writable by the user executing the agent. Defaults to ‘/var/lib/neutron’.

resync_interval

(optional) The DHCP agent will resync its state with Neutron to recover from any transient notification or rpc errors. The interval is number of seconds between attempts. Defaults to 30.

interface_driver

(optional) Defaults to ‘neutron.agent.linux.interface.OVSInterfaceDriver’.

dhcp_driver

(optional) Defaults to $::os_service_default.

root_helper

(optional) Defaults to ‘sudo neutron-rootwrap /etc/neutron/rootwrap.conf’. Addresses bug: bugs.launchpad.net/neutron/+bug/1182616 Note: This can safely be removed once the module only targets the Havana release.

dnsmasq_config_file

(optional) Override the default dnsmasq settings with this file. Defaults to $::os_service_default

dnsmasq_dns_servers

(optional) List of servers to use as dnsmasq forwarders. Defaults to $::os_service_default.

dnsmasq_base_log_dir

(optional) base log dir for dnsmasq logging. Defaults to $::os_service_default.

dnsmasq_local_resolv

(optional) Enables the dnsmasq service to provide name resolution for instances via DNS resolvers on the host running the DHCP agent. Defaults to $::os_service_default.

dnsmasq_lease_max

(optional) Limit number of leases to prevent a denial-of-service. Defaults to $::os_service_default.

dnsmasq_enable_addr6_list

(optional) Enable dhcp-host entry with list of addresses when port has multiple IPv6 addresses in the same subnet. Defaults to $::os_service_default.

enable_isolated_metadata

(optional) enable metadata support on isolated networks. Defaults to false.

enable_force_metadata

(optional) enable metadata support on all networks. Defaults to $::os_service_default

enable_metadata_network

(optional) Allows for serving metadata requests coming from a dedicated metadata access network whose cidr is 169.254.169.254/16 (or larger prefix), and is connected to a Neutron router from which the VMs send metadata request. This option requires enable_isolated_metadata = True Defaults to false.

dhcp_broadcast_reply

(optional) Use broadcast in DHCP replies Defaults to $::os_service_default.

purge_config

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

availability_zone

(optional) The availability zone of the agent. Neutron will only schedule dhcp on the agent based on availability zone Defaults to $::os_service_default

ovs_integration_bridge

(optional) Name of Open vSwitch bridge to use Defaults to $::os_service_default

ovsdb_connection

(optional) The URI used to connect to the local OVSDB server Defaults to $::os_service_default

ovsdb_agent_ssl_key_file

(optional) The SSL key file to use for Neutron agents to connect to OVSDB Defaults to $::os_service_default

ovsdb_agent_ssl_cert_file

(optional) The SSL cert file to use for Neutron agents to connect to OVSDB Defaults to $::os_service_default

ovsdb_agent_ssl_ca_file

(optional) The SSL CA cert file to use for Neutron agents to connect to OVSDB Defaults to $::os_service_default

report_interval

(optional) Set the agent report interval. By default the global report interval in neutron.conf ([agent]/report_interval) is used. This parameter can be used to override the reporting interval for the dhcp-agent. Defaults to $::os_service_default

rpc_response_max_timeout

(Optional) Maximum seconds to wait for a response from an RPC call Defaults to: $::os_service_default

Parameters:

  • package_ensure (Any) (defaults to: present)
  • enabled (Any) (defaults to: true)
  • manage_service (Any) (defaults to: true)
  • debug (Any) (defaults to: $::os_service_default)
  • state_path (Any) (defaults to: '/var/lib/neutron')
  • resync_interval (Any) (defaults to: 30)
  • interface_driver (Any) (defaults to: 'neutron.agent.linux.interface.OVSInterfaceDriver')
  • dhcp_driver (Any) (defaults to: $::os_service_default)
  • root_helper (Any) (defaults to: 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf')
  • dnsmasq_config_file (Any) (defaults to: $::os_service_default)
  • dnsmasq_dns_servers (Any) (defaults to: $::os_service_default)
  • dnsmasq_base_log_dir (Any) (defaults to: $::os_service_default)
  • dnsmasq_local_resolv (Any) (defaults to: $::os_service_default)
  • dnsmasq_lease_max (Any) (defaults to: $::os_service_default)
  • dnsmasq_enable_addr6_list (Any) (defaults to: $::os_service_default)
  • enable_isolated_metadata (Any) (defaults to: false)
  • enable_force_metadata (Any) (defaults to: $::os_service_default)
  • enable_metadata_network (Any) (defaults to: false)
  • dhcp_broadcast_reply (Any) (defaults to: $::os_service_default)
  • purge_config (Any) (defaults to: false)
  • availability_zone (Any) (defaults to: $::os_service_default)
  • ovs_integration_bridge (Any) (defaults to: $::os_service_default)
  • ovsdb_connection (Any) (defaults to: $::os_service_default)
  • ovsdb_agent_ssl_key_file (Any) (defaults to: $::os_service_default)
  • ovsdb_agent_ssl_cert_file (Any) (defaults to: $::os_service_default)
  • ovsdb_agent_ssl_ca_file (Any) (defaults to: $::os_service_default)
  • report_interval (Any) (defaults to: $::os_service_default)
  • rpc_response_max_timeout (Any) (defaults to: $::os_service_default)


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
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
# File 'manifests/agents/dhcp.pp', line 125

class neutron::agents::dhcp (
  $package_ensure            = present,
  $enabled                   = true,
  $manage_service            = true,
  $debug                     = $::os_service_default,
  $state_path                = '/var/lib/neutron',
  $resync_interval           = 30,
  $interface_driver          = 'neutron.agent.linux.interface.OVSInterfaceDriver',
  $dhcp_driver               = $::os_service_default,
  $root_helper               = 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf',
  $dnsmasq_config_file       = $::os_service_default,
  $dnsmasq_dns_servers       = $::os_service_default,
  $dnsmasq_base_log_dir      = $::os_service_default,
  $dnsmasq_local_resolv      = $::os_service_default,
  $dnsmasq_lease_max         = $::os_service_default,
  $dnsmasq_enable_addr6_list = $::os_service_default,
  $enable_isolated_metadata  = false,
  $enable_force_metadata     = $::os_service_default,
  $enable_metadata_network   = false,
  $dhcp_broadcast_reply      = $::os_service_default,
  $purge_config              = false,
  $availability_zone         = $::os_service_default,
  $ovs_integration_bridge    = $::os_service_default,
  $ovsdb_connection          = $::os_service_default,
  $ovsdb_agent_ssl_key_file  = $::os_service_default,
  $ovsdb_agent_ssl_cert_file = $::os_service_default,
  $ovsdb_agent_ssl_ca_file   = $::os_service_default,
  $report_interval           = $::os_service_default,
  $rpc_response_max_timeout  = $::os_service_default,
) {

  include neutron::deps
  include neutron::params

  if (! ($enable_isolated_metadata or $enable_force_metadata)) and $enable_metadata_network {
    fail('enable_metadata_network to true requires enable_isolated_metadata or enable_force_metadata also enabled.')
  } else {
    neutron_dhcp_agent_config {
      'DEFAULT/enable_isolated_metadata': value => $enable_isolated_metadata;
      'DEFAULT/force_metadata':           value => $enable_force_metadata;
      'DEFAULT/enable_metadata_network':  value => $enable_metadata_network;
    }
  }

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

  # The DHCP agent loads both neutron.conf and its own file.
  # This only lists config specific to the agent.  neutron.conf supplies
  # the rest.
  neutron_dhcp_agent_config {
    'DEFAULT/debug':                     value => $debug;
    'DEFAULT/state_path':                value => $state_path;
    'DEFAULT/resync_interval':           value => $resync_interval;
    'DEFAULT/interface_driver':          value => $interface_driver;
    'DEFAULT/dhcp_driver':               value => $dhcp_driver;
    'DEFAULT/root_helper':               value => $root_helper;
    'DEFAULT/dhcp_broadcast_reply':      value => $dhcp_broadcast_reply;
    'DEFAULT/dnsmasq_config_file':       value => $dnsmasq_config_file;
    'DEFAULT/dnsmasq_dns_servers':       value => join(any2array($dnsmasq_dns_servers), ',');
    'DEFAULT/dnsmasq_base_log_dir':      value => $dnsmasq_base_log_dir;
    'DEFAULT/dnsmasq_local_resolv':      value => $dnsmasq_local_resolv;
    'DEFAULT/dnsmasq_lease_max':         value => $dnsmasq_lease_max;
    'DEFAULT/dnsmasq_enable_addr6_list': value => $dnsmasq_enable_addr6_list;
    'agent/availability_zone':           value => $availability_zone;
    'agent/report_interval':             value => $report_interval;
    'DEFAULT/rpc_response_max_timeout':  value => $rpc_response_max_timeout;
  }

  # DEFAULT/ovs_intergation_bridge was deprecated in favor of
  # ovs/intergation_bridge. Make sure to purge the old parameter
  neutron_dhcp_agent_config {
    'DEFAULT/ovs_integration_bridge': ensure => 'absent'
  }

  if $ovsdb_connection =~ /^ssl:/ {
    $req_ssl_opts = {
      'ovsdb_agent_ssl_key_file'  => $ovsdb_agent_ssl_key_file,
      'ovsdb_agent_ssl_cert_file' => $ovsdb_agent_ssl_cert_file,
      'ovsdb_agent_ssl_ca_file'   => $ovsdb_agent_ssl_ca_file
    }
    $req_ssl_opts.each |$opts| {
      if !$opts[1] or is_service_default($opts[1]) {
        fail(
          "${opts[0]} must be provided when using an SSL ovsdb_connection URI"
        )
      }
    }
  }

  neutron_dhcp_agent_config {
    'OVS/ovsdb_connection':   value => $ovsdb_connection;
    'OVS/integration_bridge': value => $ovs_integration_bridge;
    'OVS/ssl_key_file':       value => $ovsdb_agent_ssl_key_file;
    'OVS/ssl_cert_file':      value => $ovsdb_agent_ssl_cert_file;
    'OVS/ssl_ca_cert_file':   value => $ovsdb_agent_ssl_ca_file;
  }

  if $::neutron::params::dhcp_agent_package {
    package { 'neutron-dhcp-agent':
      ensure => $package_ensure,
      name   => $::neutron::params::dhcp_agent_package,
      tag    => ['openstack', 'neutron-package'],
    }
  }

  if $manage_service {
    if $enabled {
      $service_ensure = 'running'
    } else {
      $service_ensure = 'stopped'
    }
    service { 'neutron-dhcp-service':
      ensure => $service_ensure,
      name   => $::neutron::params::dhcp_agent_service,
      enable => $enabled,
      tag    => 'neutron-service',
    }
  }
}