Puppet Class: octavia::controller

Inherits:
octavia::params
Defined in:
manifests/controller.pp

Overview

Class: octavia::controller

Parameters

heartbeat_key

(required) Key to validate amphora messages. Defaults to undef

amp_active_retries

(optional) Retry attempts to wait for Amphora to become active. Defaults to $facts

amp_active_wait_sec

(optional) Seconds to wait between checks on whether an Amphora has become active. Defaults to $facts

amp_flavor_id

(optional) Nova instance flavor id for the Amphora. Note: since we set manage_nova_flavor to True by default, we need to set a valid amp_flavor_id by default, 65 was picked randomly. Defaults to ‘65’.

amp_image_tag

Glance image tag for Amphora image. Allows the Amphora image to be referred to by a tag instead of an ID, allowing the Amphora image to be updated without requiring reconfiguration of Octavia. Defaults to $facts

amp_image_owner_id

Restrict glance image selection to a specific owner ID. This is a recommended security setting. Defaults to $facts

amp_secgroup_list

List of security groups to use for Amphorae. Defaults to $facts

amp_boot_network_list

List of networks to attach to Amphorae. Defaults to $facts

loadbalancer_topology

(optional) Load balancer topology configuration Defaults to $facts

amphora_driver

(optional) Name of driver for communicating with amphorae Defaults to $facts

compute_driver

(optional) Name of driver for managing amphorae VMs Defaults to $facts

network_driver

(optional) Name of network driver for configuring networking for amphorae. Defaults to $facts

volume_driver

(optional) Name of volume driver for managing amphora volumes Defaults to $facts

image_driver

(optional) Name of volume driver for managing amphora image Defaults to $facts

amp_timezone

(optional) Defines the timezone to use as represented in /usr/share/zoneinfo. Defaults to $facts

amphora_delete_retries

(optional) Number of times an amphora delete should be retried. Defaults to $facts

amphora_delete_retry_interval

(optional) Time, in seconds, between amphora delete retries. Defaults to $facts

event_notifications

(optional) Enable octavia event notifications. Defaults to $facts

db_commit_retry_attempts

(optional) The number of times the database action will be attempted. Defaults to $facts

db_commit_retry_initial_delay

(optional) The time to backoff retry attempt. Defaults to $facts

db_commit_retry_backoff

(optional) Tie time to backoff retry attempts. Defaults to $facts

db_commit_retry_max

(optional) The maximum amount of time to wait between retry attempts. Defaults to $facts

amp_ssh_key_name

(optional) Name of Openstack SSH keypair for communicating with amphora Defaults to ‘octavia-ssh-key’

enable_ssh_access

(optional) Enable SSH key configuration for amphorae. Note that setting to false disables configuration of SSH key related properties. Defaults to true

timeout_client_data

(optional) Frontend client inactivity timeout. Defaults to $facts

timeout_member_connect

(optional) Backend member connection timeout. Defaults to $facts

timeout_member_data

(optional) Backend member inactivity timeout.‘ Defaults to $facts

timeout_tcp_inspect

(optional) Time to wait for TCP packets for content inspection. Defaults to $facts

connection_max_retries

(optional) Maximum number of retries when contacting amphora. Defaults to $facts

connection_retry_interval

(optional) Number of seconds to wait between connection attempts to amphora. Defaults to $facts

active_connection_max_retries

(optional) Retry threshold for connecting to active amphorae. Defaults to $facts

active_connection_retry_interval

(optional) Retry timeout between connection attempts in seconds for active amphora. Defaults to $facts

failover_connection_max_retries

(optional) Retry threshold for connecting to an amphora in failover. Defaults to $facts

failover_connection_retry_interval

(optional) Retry timeout between connection attempts in seconds for amphora in failover. Defaults to $facts

connection_logging

(optional) When false, disables logging of tenant connection flows. This includes storing them locally and sending them to the tenant syslog endpoints. Defaults to $facts

build_rate_limit

(optional) Number of amphorae that could be build per controller worker, simultaneously. Defaults to $facts

build_active_retries

(optional) Retry threshold for waiting for a build slot for an amphorae. Defaults to $facts

build_retry_interval

(optional) Retry timeout between build attempts in seconds. Defaults to $facts

api_db_commit_retry_attempts

(optional) The number of times the database action will be attempted. Defaults to $facts

api_db_commit_retry_initial_delay

(optional) The time to backoff retry attempt. Defaults to $facts

api_db_commit_retry_backoff

(optional) Tie time to backoff retry attempts. Defaults to $facts

api_db_commit_retry_max

(optional) The maximum amount of time to wait between retry attempts. Defaults to $facts

default_connection_limit

(optional) Default connection_limit for listeners. Defaults to $facts

agent_request_read_timeout

(optional) The time in seconds to allow a request from the controller to run before terminating the socket. Defaults to $facts

agent_tls_protocol

(optional) Minimum TLS protocol for communication with the amphora agent. Defaults to $facts

admin_log_targets

(optional) The list of syslog endpoints, host:port comma separated list, to receive administrative log messages. Defaults to $facts

administrative_log_facility

(optional) The syslog “LOG_LOCAL” facility to use for the administrative log messages. Defaults to $facts

forward_all_logs

(optional) When true, all log messages from the amphora will be forwarded to the administrative log endpoints, including non-load balancing related logs. Defaults to $facts

tenant_log_targets

(optional) The list of syslog endpoints, host:port comma separated list, to receive tenant traffic flow log messages. Defaults to $facts

user_log_facility

(optional) The syslog “LOG_LOCAL” facility to use for the tenant traffic flow log messages. Defaults to $facts

user_log_format

(optional) The tenant traffic flow log format string. Defaults to $facts

log_protocol

(optional) The log forwarding transport protoocl. One of UDP or TCP. Defaults to $facts

log_retry_count

(optional) The maximum attempts to retry connecting to the logging host. Defaults to $facts

log_retry_interval

(optional) The time, in seconds, to wait between retries connecting to the logging host. Defaults to $facts

log_queue_size

(optional) The queue size (messages) to buffer log messages. Defaults to $facts

logging_template_override

(optional) Custom logging configuration template. Defaults to $facts

disable_local_log_storage

(optional) When true, logs will not be stored on the amphora filesystem. This includes all kernel, system, and security logs. Defaults to $facts

vrrp_advert_int

(optional) Amphora role and priority advertisement internal in seconds. Defaults to $facts

vrrp_check_interval

(optional) VRRP health check script run interval in seconds. Defaults to $facts

vrrp_fail_count

(optional) Number of successive failures before transition to a fail rate. Defaults to $facts

vrrp_success_count

(optional) Number of consecutive successes before transition to a success rate. Defaults to $facts

vrrp_garp_refresh_interval

(optional) Time in seconds between gratuitous ARP announcements from the MASTER. Defaults to $facts

vrrp_garp_refresh_count

(optional) Number of gratuitous ARP announcements to make on each refresh interval. Defaults to $facts

controller_ip_port_list

(optional) The list of controllers in a host:port comma separated list if multiple. This is added to the amphora config and is used when it connects back to the controllers to report its health. Defaults to $facts

heartbeat_interval

(optional) Sleep time between sending heartbeats. Defaults to undef

Parameters:

  • heartbeat_key (String[1])
  • amp_active_retries (Any) (defaults to: $facts['os_service_default'])
  • amp_active_wait_sec (Any) (defaults to: $facts['os_service_default'])
  • amp_flavor_id (String[1]) (defaults to: '65')
  • amp_image_tag (Any) (defaults to: $facts['os_service_default'])
  • amp_image_owner_id (Any) (defaults to: $facts['os_service_default'])
  • amp_secgroup_list (Any) (defaults to: $facts['os_service_default'])
  • amp_boot_network_list (Any) (defaults to: $facts['os_service_default'])
  • loadbalancer_topology (Any) (defaults to: $facts['os_service_default'])
  • amphora_driver (Any) (defaults to: $facts['os_service_default'])
  • compute_driver (Any) (defaults to: $facts['os_service_default'])
  • network_driver (Any) (defaults to: $facts['os_service_default'])
  • volume_driver (Any) (defaults to: $facts['os_service_default'])
  • image_driver (Any) (defaults to: $facts['os_service_default'])
  • amp_timezone (Any) (defaults to: $facts['os_service_default'])
  • amphora_delete_retries (Any) (defaults to: $facts['os_service_default'])
  • amphora_delete_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • event_notifications (Any) (defaults to: $facts['os_service_default'])
  • db_commit_retry_attempts (Any) (defaults to: $facts['os_service_default'])
  • db_commit_retry_initial_delay (Any) (defaults to: $facts['os_service_default'])
  • db_commit_retry_backoff (Any) (defaults to: $facts['os_service_default'])
  • db_commit_retry_max (Any) (defaults to: $facts['os_service_default'])
  • enable_ssh_access (Boolean) (defaults to: true)
  • amp_ssh_key_name (String[1]) (defaults to: 'octavia-ssh-key')
  • timeout_client_data (Any) (defaults to: $facts['os_service_default'])
  • timeout_member_connect (Any) (defaults to: $facts['os_service_default'])
  • timeout_member_data (Any) (defaults to: $facts['os_service_default'])
  • timeout_tcp_inspect (Any) (defaults to: $facts['os_service_default'])
  • connection_max_retries (Any) (defaults to: $facts['os_service_default'])
  • connection_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • connection_logging (Any) (defaults to: $facts['os_service_default'])
  • active_connection_max_retries (Any) (defaults to: $facts['os_service_default'])
  • active_connection_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • failover_connection_max_retries (Any) (defaults to: $facts['os_service_default'])
  • failover_connection_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • build_rate_limit (Any) (defaults to: $facts['os_service_default'])
  • build_active_retries (Any) (defaults to: $facts['os_service_default'])
  • build_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • api_db_commit_retry_attempts (Any) (defaults to: $facts['os_service_default'])
  • api_db_commit_retry_initial_delay (Any) (defaults to: $facts['os_service_default'])
  • api_db_commit_retry_backoff (Any) (defaults to: $facts['os_service_default'])
  • api_db_commit_retry_max (Any) (defaults to: $facts['os_service_default'])
  • default_connection_limit (Any) (defaults to: $facts['os_service_default'])
  • agent_request_read_timeout (Any) (defaults to: $facts['os_service_default'])
  • agent_tls_protocol (Any) (defaults to: $facts['os_service_default'])
  • admin_log_targets (Any) (defaults to: $facts['os_service_default'])
  • administrative_log_facility (Any) (defaults to: $facts['os_service_default'])
  • forward_all_logs (Any) (defaults to: $facts['os_service_default'])
  • tenant_log_targets (Any) (defaults to: $facts['os_service_default'])
  • user_log_facility (Any) (defaults to: $facts['os_service_default'])
  • user_log_format (Any) (defaults to: $facts['os_service_default'])
  • log_protocol (Any) (defaults to: $facts['os_service_default'])
  • log_retry_count (Any) (defaults to: $facts['os_service_default'])
  • log_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • log_queue_size (Any) (defaults to: $facts['os_service_default'])
  • logging_template_override (Any) (defaults to: $facts['os_service_default'])
  • disable_local_log_storage (Any) (defaults to: $facts['os_service_default'])
  • vrrp_advert_int (Any) (defaults to: $facts['os_service_default'])
  • vrrp_check_interval (Any) (defaults to: $facts['os_service_default'])
  • vrrp_fail_count (Any) (defaults to: $facts['os_service_default'])
  • vrrp_success_count (Any) (defaults to: $facts['os_service_default'])
  • vrrp_garp_refresh_interval (Any) (defaults to: $facts['os_service_default'])
  • vrrp_garp_refresh_count (Any) (defaults to: $facts['os_service_default'])
  • controller_ip_port_list (Any) (defaults to: $facts['os_service_default'])
  • heartbeat_interval (Any) (defaults to: $facts['os_service_default']) 


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
 
# File 'manifests/controller.pp', line 290

class octavia::controller (
  String[1] $heartbeat_key,
  $amp_active_retries                 = $facts['os_service_default'],
  $amp_active_wait_sec                = $facts['os_service_default'],
  String[1] $amp_flavor_id            = '65',
  $amp_image_tag                      = $facts['os_service_default'],
  $amp_image_owner_id                 = $facts['os_service_default'],
  $amp_secgroup_list                  = $facts['os_service_default'],
  $amp_boot_network_list              = $facts['os_service_default'],
  $loadbalancer_topology              = $facts['os_service_default'],
  $amphora_driver                     = $facts['os_service_default'],
  $compute_driver                     = $facts['os_service_default'],
  $network_driver                     = $facts['os_service_default'],
  $volume_driver                      = $facts['os_service_default'],
  $image_driver                       = $facts['os_service_default'],
  $amp_timezone                       = $facts['os_service_default'],
  $amphora_delete_retries             = $facts['os_service_default'],
  $amphora_delete_retry_interval      = $facts['os_service_default'],
  $event_notifications                = $facts['os_service_default'],
  $db_commit_retry_attempts           = $facts['os_service_default'],
  $db_commit_retry_initial_delay      = $facts['os_service_default'],
  $db_commit_retry_backoff            = $facts['os_service_default'],
  $db_commit_retry_max                = $facts['os_service_default'],
  Boolean $enable_ssh_access          = true,
  String[1] $amp_ssh_key_name         = 'octavia-ssh-key',
  $timeout_client_data                = $facts['os_service_default'],
  $timeout_member_connect             = $facts['os_service_default'],
  $timeout_member_data                = $facts['os_service_default'],
  $timeout_tcp_inspect                = $facts['os_service_default'],
  $connection_max_retries             = $facts['os_service_default'],
  $connection_retry_interval          = $facts['os_service_default'],
  $connection_logging                 = $facts['os_service_default'],
  $active_connection_max_retries      = $facts['os_service_default'],
  $active_connection_retry_interval   = $facts['os_service_default'],
  $failover_connection_max_retries    = $facts['os_service_default'],
  $failover_connection_retry_interval = $facts['os_service_default'],
  $build_rate_limit                   = $facts['os_service_default'],
  $build_active_retries               = $facts['os_service_default'],
  $build_retry_interval               = $facts['os_service_default'],
  $api_db_commit_retry_attempts       = $facts['os_service_default'],
  $api_db_commit_retry_initial_delay  = $facts['os_service_default'],
  $api_db_commit_retry_backoff        = $facts['os_service_default'],
  $api_db_commit_retry_max            = $facts['os_service_default'],
  $default_connection_limit           = $facts['os_service_default'],
  $agent_request_read_timeout         = $facts['os_service_default'],
  $agent_tls_protocol                 = $facts['os_service_default'],
  $admin_log_targets                  = $facts['os_service_default'],
  $administrative_log_facility        = $facts['os_service_default'],
  $forward_all_logs                   = $facts['os_service_default'],
  $tenant_log_targets                 = $facts['os_service_default'],
  $user_log_facility                  = $facts['os_service_default'],
  $user_log_format                    = $facts['os_service_default'],
  $log_protocol                       = $facts['os_service_default'],
  $log_retry_count                    = $facts['os_service_default'],
  $log_retry_interval                 = $facts['os_service_default'],
  $log_queue_size                     = $facts['os_service_default'],
  $logging_template_override          = $facts['os_service_default'],
  $disable_local_log_storage          = $facts['os_service_default'],
  $vrrp_advert_int                    = $facts['os_service_default'],
  $vrrp_check_interval                = $facts['os_service_default'],
  $vrrp_fail_count                    = $facts['os_service_default'],
  $vrrp_success_count                 = $facts['os_service_default'],
  $vrrp_garp_refresh_interval         = $facts['os_service_default'],
  $vrrp_garp_refresh_count            = $facts['os_service_default'],
  $controller_ip_port_list            = $facts['os_service_default'],
  $heartbeat_interval                 = $facts['os_service_default'],
) inherits octavia::params {

  include octavia::deps
  include octavia::db

  if ! is_service_default($loadbalancer_topology) and
      ! ($loadbalancer_topology in ['SINGLE', 'ACTIVE_STANDBY']) {
    fail('load balancer topology must be one of SINGLE or ACTIVE_STANDBY')
  }

  if $enable_ssh_access {
    octavia_config { 'controller_worker/amp_ssh_key_name' : value => $amp_ssh_key_name; }
  }
  else {
    octavia_config { 'controller_worker/amp_ssh_key_name' : value => $facts['os_service_default'] }
  }

  octavia_config {
    'controller_worker/amp_active_retries'               : value => $amp_active_retries;
    'controller_worker/amp_active_wait_sec'              : value => $amp_active_wait_sec;
    'controller_worker/amp_flavor_id'                    : value => $amp_flavor_id;
    'controller_worker/amp_image_tag'                    : value => $amp_image_tag;
    'controller_worker/amp_image_owner_id'               : value => $amp_image_owner_id;
    'controller_worker/amp_secgroup_list'                : value => join(any2array($amp_secgroup_list), ',');
    'controller_worker/amp_boot_network_list'            : value => join(any2array($amp_boot_network_list), ',');
    'controller_worker/loadbalancer_topology'            : value => $loadbalancer_topology;
    'controller_worker/amphora_driver'                   : value => $amphora_driver;
    'controller_worker/compute_driver'                   : value => $compute_driver;
    'controller_worker/network_driver'                   : value => $network_driver;
    'controller_worker/volume_driver'                    : value => $volume_driver;
    'controller_worker/image_driver'                     : value => $image_driver;
    'controller_worker/amp_timezone'                     : value => $amp_timezone;
    'controller_worker/amphora_delete_retries'           : value => $amphora_delete_retries;
    'controller_worker/amphora_delete_retry_interval'    : value => $amphora_delete_retry_interval;
    'controller_worker/event_notifications'              : value => $event_notifications;
    'controller_worker/db_commit_retry_attempts'         : value => $db_commit_retry_attempts;
    'controller_worker/db_commit_retry_initial_delay'    : value => $db_commit_retry_initial_delay;
    'controller_worker/db_commit_retry_backoff'          : value => $db_commit_retry_backoff;
    'controller_worker/db_commit_retry_max'              : value => $db_commit_retry_max;
    'haproxy_amphora/timeout_client_data'                : value => $timeout_client_data;
    'haproxy_amphora/timeout_member_connect'             : value => $timeout_member_connect;
    'haproxy_amphora/timeout_member_data'                : value => $timeout_member_data;
    'haproxy_amphora/timeout_tcp_inspect'                : value => $timeout_tcp_inspect;
    'haproxy_amphora/connection_max_retries'             : value => $connection_max_retries;
    'haproxy_amphora/connection_retry_interval'          : value => $connection_retry_interval;
    'haproxy_amphora/connection_logging'                 : value => $connection_logging;
    'haproxy_amphora/active_connection_max_retries'      : value => $active_connection_max_retries;
    'haproxy_amphora/active_connection_retry_interval'   : value => $active_connection_retry_interval;
    'haproxy_amphora/failover_connection_max_retries'    : value => $failover_connection_max_retries;
    'haproxy_amphora/failover_connection_retry_interval' : value => $failover_connection_retry_interval;
    'haproxy_amphora/build_rate_limit'                   : value => $build_rate_limit;
    'haproxy_amphora/build_active_retries'               : value => $build_active_retries;
    'haproxy_amphora/build_retry_interval'               : value => $build_retry_interval;
    'haproxy_amphora/api_db_commit_retry_attempts'       : value => $api_db_commit_retry_attempts;
    'haproxy_amphora/api_db_commit_retry_initial_delay'  : value => $api_db_commit_retry_initial_delay;
    'haproxy_amphora/api_db_commit_retry_backoff'        : value => $api_db_commit_retry_backoff;
    'haproxy_amphora/api_db_commit_retry_max'            : value => $api_db_commit_retry_max;
    'haproxy_amphora/default_connection_limit'           : value => $default_connection_limit;
    'amphora_agent/agent_request_read_timeout'           : value => $agent_request_read_timeout;
    'amphora_agent/agent_tls_protocol'                   : value => $agent_tls_protocol;
    'amphora_agent/admin_log_targets'                    : value => join(any2array($admin_log_targets), ',');
    'amphora_agent/administrative_log_facility'          : value => $administrative_log_facility;
    'amphora_agent/forward_all_logs'                     : value => $forward_all_logs;
    'amphora_agent/tenant_log_targets'                   : value => join(any2array($tenant_log_targets), ',');
    'amphora_agent/user_log_facility'                    : value => $user_log_facility;
    'haproxy_amphora/user_log_format'                    : value => $user_log_format;
    'amphora_agent/log_protocol'                         : value => $log_protocol;
    'amphora_agent/log_retry_count'                      : value => $log_retry_count;
    'amphora_agent/log_retry_interval'                   : value => $log_retry_interval;
    'amphora_agent/log_queue_size'                       : value => $log_queue_size;
    'amphora_agent/logging_template_override'            : value => $logging_template_override;
    'amphora_agent/disable_local_log_storage'            : value => $disable_local_log_storage;
    'keepalived_vrrp/vrrp_advert_int'                    : value => $vrrp_advert_int;
    'keepalived_vrrp/vrrp_check_interval'                : value => $vrrp_check_interval;
    'keepalived_vrrp/vrrp_fail_count'                    : value => $vrrp_fail_count;
    'keepalived_vrrp/vrrp_success_count'                 : value => $vrrp_success_count;
    'keepalived_vrrp/vrrp_garp_refresh_interval'         : value => $vrrp_garp_refresh_interval;
    'keepalived_vrrp/vrrp_garp_refresh_count'            : value => $vrrp_garp_refresh_count;
    'health_manager/controller_ip_port_list'             : value => join(any2array($controller_ip_port_list), ',');
    'health_manager/heartbeat_key'                       : value => $heartbeat_key, secret => true;
    'health_manager/heartbeat_interval'                  : value => $heartbeat_interval;
  }
}