Puppet Class: neutron::agents::l3

Defined in:
manifests/agents/l3.pp

Overview

Class: neutron::agents::l3

Installs and configures the Neutron L3 service

TODO: create ability to have multiple L3 services

Parameters

package_ensure

(optional) The state of the package Defaults to present

enabled

(optional) The state of the service Defaults to true

manage_service

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

debug

(optional) Print debug info in logs Defaults to $::os_service_default

interface_driver

(optional) Driver to interface with neutron Defaults to OVSInterfaceDriver

handle_internal_only_routers

(optional) L3 Agent will handle non-external routers Defaults to $::os_service_default

metadata_port

(optional) The port of the metadata server Defaults to $::os_service_default

periodic_interval

(optional) seconds between re-sync routers’ data if needed Defaults to $::os_service_default

periodic_fuzzy_delay

(optional) seconds to start to sync routers’ data after starting agent Defaults to $::os_service_default

enable_metadata_proxy

(optional) can be set to False if the Nova metadata server is not available Defaults to $::os_service_default

ha_enabled

(optional) Enabled or not HA for L3 agent. Defaults to false

ha_vrrp_auth_type

(optional) VRRP authentication type. Can be AH or PASS. Defaults to “PASS”

ha_vrrp_auth_password

(optional) VRRP authentication password. Required if ha_enabled = true. Defaults to $::os_service_default

ha_vrrp_advert_int

(optional) The advertisement interval in seconds. Defaults to ‘2’

agent_mode

(optional) The working mode for the agent. ‘legacy’: default behavior (without DVR) ‘dvr’: enable DVR for an L3 agent running on compute node (DVR in production) ‘dvr_snat’: enable DVR with centralized SNAT support (DVR for single-host, for testing only) Defaults to ‘legacy’

purge_config

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

availability_zone

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

extensions

(optional) List of the L3 agent extensions to enable. 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 l3-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

radvd_user

(optional) The username passed to radvd, used to drop root privileges and change user ID to username and group ID to the primary group of username. If no user specified, the user executing the L3 agent will be passed. If “root” specified, because radvd is spawned as root, no “username” parameter will be passed. Defaults to $::os_service_default

ovs_integration_bridge

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

network_log_rate_limit

(Optional) Maximum packets logging per second. Used by logging service plugin. Defaults to $::os_service_default. Minimum possible value is 100.

network_log_burst_limit

(Optional) Maximum number of packets per rate_limit. Used by logging service plugin. Defaults to $::os_service_default. Minimum possible value is 25.

network_log_local_output_log_base

(Optional) Output logfile path on agent side, default syslog file. Used by logging service plugin. Defaults to $::os_service_default.

DEPRECATED PARAMETERS

gateway_external_network_id

(optional) The ID of the external network in neutron Defaults to undef

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)
  • interface_driver (Any) (defaults to: 'neutron.agent.linux.interface.OVSInterfaceDriver')
  • handle_internal_only_routers (Any) (defaults to: $::os_service_default)
  • metadata_port (Any) (defaults to: $::os_service_default)
  • periodic_interval (Any) (defaults to: $::os_service_default)
  • periodic_fuzzy_delay (Any) (defaults to: $::os_service_default)
  • enable_metadata_proxy (Any) (defaults to: $::os_service_default)
  • ha_enabled (Any) (defaults to: false)
  • ha_vrrp_auth_type (Any) (defaults to: 'PASS')
  • ha_vrrp_auth_password (Any) (defaults to: $::os_service_default)
  • ha_vrrp_advert_int (Any) (defaults to: '3')
  • agent_mode (Any) (defaults to: 'legacy')
  • purge_config (Any) (defaults to: false)
  • availability_zone (Any) (defaults to: $::os_service_default)
  • extensions (Any) (defaults to: $::os_service_default)
  • report_interval (Any) (defaults to: $::os_service_default)
  • rpc_response_max_timeout (Any) (defaults to: $::os_service_default)
  • radvd_user (Any) (defaults to: $::os_service_default)
  • ovs_integration_bridge (Any) (defaults to: $::os_service_default)
  • network_log_rate_limit (Any) (defaults to: $::os_service_default)
  • network_log_burst_limit (Any) (defaults to: $::os_service_default)
  • network_log_local_output_log_base (Any) (defaults to: $::os_service_default)
  • gateway_external_network_id (Any) (defaults to: undef)


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
# File 'manifests/agents/l3.pp', line 131

class neutron::agents::l3 (
  $package_ensure                    = 'present',
  $enabled                           = true,
  $manage_service                    = true,
  $debug                             = $::os_service_default,
  $interface_driver                  = 'neutron.agent.linux.interface.OVSInterfaceDriver',
  $handle_internal_only_routers      = $::os_service_default,
  $metadata_port                     = $::os_service_default,
  $periodic_interval                 = $::os_service_default,
  $periodic_fuzzy_delay              = $::os_service_default,
  $enable_metadata_proxy             = $::os_service_default,
  $ha_enabled                        = false,
  $ha_vrrp_auth_type                 = 'PASS',
  $ha_vrrp_auth_password             = $::os_service_default,
  $ha_vrrp_advert_int                = '3',
  $agent_mode                        = 'legacy',
  $purge_config                      = false,
  $availability_zone                 = $::os_service_default,
  $extensions                        = $::os_service_default,
  $report_interval                   = $::os_service_default,
  $rpc_response_max_timeout          = $::os_service_default,
  $radvd_user                        = $::os_service_default,
  $ovs_integration_bridge            = $::os_service_default,
  $network_log_rate_limit            = $::os_service_default,
  $network_log_burst_limit           = $::os_service_default,
  $network_log_local_output_log_base = $::os_service_default,
  # DEPRECATED PARAMETERS
  $gateway_external_network_id      = undef,
) {

  include neutron::deps
  include neutron::params

  if $gateway_external_network_id != undef {
    warning('gateway_external_network_id parameter is deprecated and has no effect')
  }

  neutron_l3_agent_config {
    'DEFAULT/gateway_external_network_id': ensure => absent;
  }

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

  if $ha_enabled {
    neutron_l3_agent_config {
      'DEFAULT/ha_vrrp_auth_type':     value => $ha_vrrp_auth_type;
      'DEFAULT/ha_vrrp_auth_password': value => $ha_vrrp_auth_password, secret => true;
      'DEFAULT/ha_vrrp_advert_int':    value => $ha_vrrp_advert_int;
    }
  } else {
    neutron_l3_agent_config {
      'DEFAULT/ha_vrrp_auth_type':     ensure => absent;
      'DEFAULT/ha_vrrp_auth_password': ensure => absent;
      'DEFAULT/ha_vrrp_advert_int':    ensure => absent;
    }
  }

  neutron_l3_agent_config {
    'DEFAULT/debug':                        value => $debug;
    'DEFAULT/interface_driver':             value => $interface_driver;
    'DEFAULT/handle_internal_only_routers': value => $handle_internal_only_routers;
    'DEFAULT/metadata_port':                value => $metadata_port;
    'DEFAULT/periodic_interval':            value => $periodic_interval;
    'DEFAULT/periodic_fuzzy_delay':         value => $periodic_fuzzy_delay;
    'DEFAULT/enable_metadata_proxy':        value => $enable_metadata_proxy;
    'DEFAULT/agent_mode':                   value => $agent_mode;
    'DEFAULT/radvd_user':                   value => $radvd_user;
    'ovs/integration_bridge':               value => $ovs_integration_bridge;
    'agent/availability_zone':              value => $availability_zone;
    'agent/extensions':                     value => join(any2array($extensions), ',');
    'agent/report_interval':                value => $report_interval;
    'DEFAULT/rpc_response_max_timeout':     value => $rpc_response_max_timeout;
    'network_log/rate_limit':               value => $network_log_rate_limit;
    'network_log/burst_limit':              value => $network_log_burst_limit;
    'network_log/local_output_log_base':    value => $network_log_local_output_log_base;
  }

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

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