Puppet Class: neutron::server
- Defined in:
- manifests/server.pp
Overview
Class: neutron::server
Setup and configure the neutron API endpoint
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
- log_file
-
REMOVED: Use log_file of neutron class instead.
- log_dir
-
REMOVED: Use log_dir of neutron class instead.
- auth_password
-
(optional) The password to use for authentication (keystone) Defaults to false. Set a value unless you are using noauth
- auth_type
-
(optional) What auth system to use Defaults to ‘keystone’. Can other be ‘noauth’
- auth_host
-
(optional) The keystone host Defaults to localhost
- auth_protocol
-
(optional) The protocol used to access the auth host Defaults to http.
- auth_port
-
(optional) The keystone auth port Defaults to 35357
- auth_admin_prefix
-
(optional) The admin_prefix used to admin endpoint of the auth host This allow admin auth URIs like auth_host:35357/keystone. (where ‘/keystone’ is the admin prefix) Defaults to false for empty. If defined, should be a string with a leading ‘/’ and no trailing ‘/’.
- auth_tenant
-
(optional) The tenant of the auth user Defaults to services
- auth_user
-
(optional) The name of the auth user Defaults to neutron
- auth_protocol
-
(optional) The protocol to connect to keystone Defaults to http
- auth_uri
-
(optional) Complete public Identity API endpoint. Defaults to: $auth_protocol://$auth_host:5000/
- database_connection
-
(optional) Connection url for the neutron database. (Defaults to ‘sqlite:////var/lib/neutron/ovs.sqlite’)
- sql_connection
-
DEPRECATED: Use database_connection instead.
- connection
-
DEPRECATED: Use database_connection instead.
- database_max_retries
-
(optional) Maximum database connection retries during startup. (Defaults to 10)
- sql_max_retries
-
DEPRECATED: Use database_max_retries instead.
- max_retries
-
DEPRECATED: Use database_max_retries instead.
- database_idle_timeout
-
(optional) Timeout before idle database connections are reaped. Deprecates sql_idle_timeout (Defaults to 3600)
- sql_idle_timeout
-
DEPRECATED: Use database_idle_timeout instead.
- idle_timeout
-
DEPRECATED: Use database_idle_timeout instead.
- database_retry_interval
-
(optional) Interval between retries of opening a database connection. (Defaults to 10)
- sql_reconnect_interval
-
DEPRECATED: Use database_retry_interval instead.
- retry_interval
-
DEPRECATED: Use database_retry_interval instead.
- database_min_pool_size
-
(optional) Minimum number of SQL connections to keep open in a pool. Defaults to: 1
- database_max_pool_size
-
(optional) Maximum number of SQL connections to keep open in a pool. Defaults to: 10
- database_max_overflow
-
(optional) If set, use this value for max_overflow with sqlalchemy. Defaults to: 20
- sync_db
-
(optional) Run neutron-db-manage on api nodes after installing the package. Defaults to false
- api_workers
-
(optional) Number of separate worker processes to spawn. The default, count of machine’s processors, runs the worker thread in the current process. Greater than 0 launches that number of child processes as workers. The parent process manages them. Defaults to: $::processorcount
- rpc_workers
-
(optional) Number of separate RPC worker processes to spawn. The default, count of machine’s processors, runs the worker thread in the current process. Greater than 0 launches that number of child processes as workers. The parent process manages them. Defaults to: $::processorcount
- agent_down_time
-
(optional) Seconds to regard the agent as down; should be at least twice report_interval, to be sure the agent is down for good. 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: 75
- router_scheduler_driver
-
(optional) Driver to use for scheduling router to a default L3 agent. Could be: neutron.scheduler.l3_agent_scheduler.ChanceScheduler to schedule a router in a random way neutron.scheduler.l3_agent_scheduler.LeastRoutersScheduler to allocate on an L3 agent with the least number of routers bound. Defaults to: neutron.scheduler.l3_agent_scheduler.ChanceScheduler
- mysql_module
-
(optional) Deprecated. Does nothing.
- router_distributed
-
(optional) Setting the “router_distributed” flag to “True” will default to the creation of distributed tenant routers. Also can be the type of the router on the create request (admin-only attribute). Defaults to false
- l3_ha
-
(optional) Enable high availability for virtual routers. Defaults to false
- max_l3_agents_per_router
-
(optional) Maximum number of l3 agents which a HA router will be scheduled on. If set to ‘0’, a router will be scheduled on every agent. Defaults to ‘3’
- min_l3_agents_per_router
-
(optional) Minimum number of l3 agents which a HA router will be scheduled on. Defaults to ‘2’
- l3_ha_net_cidr
-
(optional) CIDR of the administrative network if HA mode is enabled. Defaults to ‘169.254.192.0/18’
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 246 247 248 249 250 251 252 253 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 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 |
# File 'manifests/server.pp', line 178
class neutron::server (
$package_ensure = 'present',
$enabled = true,
$manage_service = true,
$auth_password = false,
$auth_type = 'keystone',
$auth_host = 'localhost',
$auth_port = '35357',
$auth_admin_prefix = false,
$auth_tenant = 'services',
$auth_user = 'neutron',
$auth_protocol = 'http',
$auth_uri = false,
$database_connection = 'sqlite:////var/lib/neutron/ovs.sqlite',
$database_max_retries = 10,
$database_idle_timeout = 3600,
$database_retry_interval = 10,
$database_min_pool_size = 1,
$database_max_pool_size = 10,
$database_max_overflow = 20,
$sync_db = false,
$api_workers = $::processorcount,
$rpc_workers = $::processorcount,
$agent_down_time = '75',
$router_scheduler_driver = 'neutron.scheduler.l3_agent_scheduler.ChanceScheduler',
$router_distributed = false,
$l3_ha = false,
$max_l3_agents_per_router = 3,
$min_l3_agents_per_router = 2,
$l3_ha_net_cidr = '169.254.192.0/18',
# DEPRECATED PARAMETERS
$mysql_module = undef,
$sql_connection = undef,
$connection = undef,
$sql_max_retries = undef,
$max_retries = undef,
$sql_idle_timeout = undef,
$idle_timeout = undef,
$sql_reconnect_interval = undef,
$retry_interval = undef,
$log_dir = undef,
$log_file = undef,
$report_interval = undef,
) {
include neutron::params
include neutron::policy
require keystone::python
Nova_admin_tenant_id_setter<||> ~> Service['neutron-server']
Neutron_config<||> ~> Service['neutron-server']
Neutron_api_config<||> ~> Service['neutron-server']
Class['neutron::policy'] ~> Service['neutron-server']
if $l3_ha {
if $min_l3_agents_per_router <= $max_l3_agents_per_router or $max_l3_agents_per_router == '0' {
neutron_config {
'DEFAULT/l3_ha': value => true;
'DEFAULT/max_l3_agents_per_router': value => $max_l3_agents_per_router;
'DEFAULT/min_l3_agents_per_router': value => $min_l3_agents_per_router;
'DEFAULT/l3_ha_net_cidr': value => $l3_ha_net_cidr;
}
} else {
fail('min_l3_agents_per_router should be less than or equal to max_l3_agents_per_router.')
}
} else {
neutron_config {
'DEFAULT/l3_ha': value => false;
}
}
if $mysql_module {
warning('The mysql_module parameter is deprecated. The latest 2.x mysql module will be used.')
}
if $sql_connection {
warning('The sql_connection parameter is deprecated, use database_connection instead.')
$database_connection_real = $sql_connection
} elsif $connection {
warning('The connection parameter is deprecated, use database_connection instead.')
$database_connection_real = $connection
} else {
$database_connection_real = $database_connection
}
if $sql_max_retries {
warning('The sql_max_retries parameter is deprecated, use database_max_retries instead.')
$database_max_retries_real = $sql_max_retries
} elsif $max_retries {
warning('The max_retries parameter is deprecated, use database_max_retries instead.')
$database_max_retries_real = $max_retries
} else {
$database_max_retries_real = $database_max_retries
}
if $sql_idle_timeout {
warning('The sql_idle_timeout parameter is deprecated, use database_idle_timeout instead.')
$database_idle_timeout_real = $sql_idle_timeout
} elsif $idle_timeout {
warning('The dle_timeout parameter is deprecated, use database_idle_timeout instead.')
$database_idle_timeout_real = $idle_timeout
} else {
$database_idle_timeout_real = $database_idle_timeout
}
if $sql_reconnect_interval {
warning('The sql_reconnect_interval parameter is deprecated, use database_retry_interval instead.')
$database_retry_interval_real = $sql_reconnect_interval
} elsif $retry_interval {
warning('The retry_interval parameter is deprecated, use database_retry_interval instead.')
$database_retry_interval_real = $retry_interval
} else {
$database_retry_interval_real = $database_retry_interval
}
if $log_dir {
fail('The log_dir parameter is removed, use log_dir of neutron class instead.')
}
if $log_file {
fail('The log_file parameter is removed, use log_file of neutron class instead.')
}
if $report_interval {
fail('The report_interval is removed, use report_interval of neutron class instead.')
}
validate_re($database_connection_real, '(sqlite|mysql|postgresql):\/\/(\S+:\S+@\S+\/\S+)?')
case $database_connection_real {
/mysql:\/\/\S+:\S+@\S+\/\S+/: {
require 'mysql::bindings'
require 'mysql::bindings::python'
}
/postgresql:\/\/\S+:\S+@\S+\/\S+/: {
$backend_package = 'python-psycopg2'
}
/sqlite:\/\//: {
$backend_package = 'python-pysqlite2'
}
default: {
fail("Invalid database_connection parameter: ${database_connection_real}")
}
}
if $sync_db {
if ($::neutron::params::server_package) {
# Debian platforms
Package<| title == 'neutron-server' |> ~> Exec['neutron-db-sync']
} else {
# RH platforms
Package<| title == 'neutron' |> ~> Exec['neutron-db-sync']
}
exec { 'neutron-db-sync':
command => 'neutron-db-manage --config-file /etc/neutron/neutron.conf --config-file /etc/neutron/plugin.ini upgrade head',
path => '/usr/bin',
before => Service['neutron-server'],
require => Neutron_config['database/connection'],
refreshonly => true
}
Neutron_config<||> ~> Exec['neutron-db-sync']
}
neutron_config {
'DEFAULT/api_workers': value => $api_workers;
'DEFAULT/rpc_workers': value => $rpc_workers;
'DEFAULT/agent_down_time': value => $agent_down_time;
'DEFAULT/router_scheduler_driver': value => $router_scheduler_driver;
'DEFAULT/router_distributed': value => $router_distributed;
'database/connection': value => $database_connection_real, secret => true;
'database/idle_timeout': value => $database_idle_timeout_real;
'database/retry_interval': value => $database_retry_interval_real;
'database/max_retries': value => $database_max_retries_real;
'database/min_pool_size': value => $database_min_pool_size;
'database/max_pool_size': value => $database_max_pool_size;
'database/max_overflow': value => $database_max_overflow;
}
if ($::neutron::params::server_package) {
Package['neutron-server'] -> Neutron_api_config<||>
Package['neutron-server'] -> Neutron_config<||>
Package['neutron-server'] -> Service['neutron-server']
Package['neutron-server'] -> Class['neutron::policy']
package { 'neutron-server':
ensure => $package_ensure,
name => $::neutron::params::server_package,
}
} else {
# Some platforms (RedHat) does not provide a neutron-server package.
# The neutron api config file is provided by the neutron package.
Package['neutron'] -> Class['neutron::policy']
Package['neutron'] -> Neutron_api_config<||>
}
if ($auth_type == 'keystone') {
if ($auth_password == false) {
fail('$auth_password must be set when using keystone authentication.')
} else {
neutron_config {
'keystone_authtoken/auth_host': value => $auth_host;
'keystone_authtoken/auth_port': value => $auth_port;
'keystone_authtoken/auth_protocol': value => $auth_protocol;
'keystone_authtoken/admin_tenant_name': value => $auth_tenant;
'keystone_authtoken/admin_user': value => $auth_user;
'keystone_authtoken/admin_password': value => $auth_password, secret => true;
}
neutron_api_config {
'filter:authtoken/auth_host': value => $auth_host;
'filter:authtoken/auth_port': value => $auth_port;
'filter:authtoken/auth_protocol': value => $auth_protocol;
'filter:authtoken/admin_tenant_name': value => $auth_tenant;
'filter:authtoken/admin_user': value => $auth_user;
'filter:authtoken/admin_password': value => $auth_password, secret => true;
}
if $auth_admin_prefix {
validate_re($auth_admin_prefix, '^(/.+[^/])?$')
neutron_config {
'keystone_authtoken/auth_admin_prefix': value => $auth_admin_prefix;
}
neutron_api_config {
'filter:authtoken/auth_admin_prefix': value => $auth_admin_prefix;
}
} else {
neutron_config {
'keystone_authtoken/auth_admin_prefix': ensure => absent;
}
neutron_api_config {
'filter:authtoken/auth_admin_prefix': ensure => absent;
}
}
if $auth_uri {
neutron_config {
'keystone_authtoken/auth_uri': value => $auth_uri;
}
neutron_api_config {
'filter:authtoken/auth_uri': value => $auth_uri;
}
} else {
neutron_config {
'keystone_authtoken/auth_uri': value => "${auth_protocol}://${auth_host}:5000/";
}
neutron_api_config {
'filter:authtoken/auth_uri': value => "${auth_protocol}://${auth_host}:5000/";
}
}
}
}
if $manage_service {
if $enabled {
$service_ensure = 'running'
} else {
$service_ensure = 'stopped'
}
}
service { 'neutron-server':
ensure => $service_ensure,
name => $::neutron::params::server_service,
enable => $enabled,
hasstatus => true,
hasrestart => true,
require => Class['neutron'],
}
}
|