Puppet Class: octavia::controller

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

Overview

Class: octavia::controller

Parameters

amp_active_retries

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

amp_active_wait_sec

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

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 $::os_service_default

amp_image_owner_id

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

amp_secgroup_list

List of security groups to use for Amphorae. Defaults to $::os_service_default

amp_boot_network_list

List of networks to attach to Amphorae. Defaults to $::os_service_default

loadbalancer_topology

(optional) Load balancer topology configuration Defaults to $::os_service_default

amphora_driver

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

compute_driver

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

network_driver

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

volume_driver

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

image_driver

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

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 $::os_service_default

timeout_member_connect

(optional) Backend member connection timeout. Defaults to $::os_service_default

timeout_member_data

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

timeout_tcp_inspect

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

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 $::os_service_default

connection_max_retries

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

connection_retry_interval

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

active_connection_max_retries

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

active_connection_retry_interval

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

failover_connection_max_retries

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

failover_connection_retry_interval

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

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 $::os_service_default

build_rate_limit

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

build_active_retries

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

build_retry_interval

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

default_connection_limit

(optional) Default connection_limit for listeners. Defaults to $::os_service_default

admin_log_targets

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

administrative_log_facility

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

forward_all_logs

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

tenant_log_targets

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

user_log_facility

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

user_log_format

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

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 $::os_service_default

vrrp_advert_int

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

vrrp_check_interval

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

vrrp_fail_count

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

vrrp_success_count

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

vrrp_garp_refresh_interval

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

vrrp_garp_refresh_count

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

DEPRECATED PARAMETERS

port_detach_timeout

(optional) Seconds to wait for a port to detach from an amphora. Defaults to undef

Parameters:

  • amp_active_retries (Any) (defaults to: $::os_service_default)
  • amp_active_wait_sec (Any) (defaults to: $::os_service_default)
  • amp_flavor_id (Any) (defaults to: '65')
  • amp_image_tag (Any) (defaults to: $::os_service_default)
  • amp_image_owner_id (Any) (defaults to: $::os_service_default)
  • amp_secgroup_list (Any) (defaults to: $::os_service_default)
  • amp_boot_network_list (Any) (defaults to: $::os_service_default)
  • loadbalancer_topology (Any) (defaults to: $::os_service_default)
  • amphora_driver (Any) (defaults to: $::os_service_default)
  • compute_driver (Any) (defaults to: $::os_service_default)
  • network_driver (Any) (defaults to: $::os_service_default)
  • volume_driver (Any) (defaults to: $::os_service_default)
  • image_driver (Any) (defaults to: $::os_service_default)
  • enable_ssh_access (Any) (defaults to: true)
  • amp_ssh_key_name (Any) (defaults to: 'octavia-ssh-key')
  • timeout_client_data (Any) (defaults to: $::os_service_default)
  • timeout_member_connect (Any) (defaults to: $::os_service_default)
  • timeout_member_data (Any) (defaults to: $::os_service_default)
  • timeout_tcp_inspect (Any) (defaults to: $::os_service_default)
  • controller_ip_port_list (Any) (defaults to: $::os_service_default)
  • connection_max_retries (Any) (defaults to: $::os_service_default)
  • connection_retry_interval (Any) (defaults to: $::os_service_default)
  • connection_logging (Any) (defaults to: $::os_service_default)
  • active_connection_max_retries (Any) (defaults to: $::os_service_default)
  • active_connection_retry_interval (Any) (defaults to: $::os_service_default)
  • failover_connection_max_retries (Any) (defaults to: $::os_service_default)
  • failover_connection_retry_interval (Any) (defaults to: $::os_service_default)
  • build_rate_limit (Any) (defaults to: $::os_service_default)
  • build_active_retries (Any) (defaults to: $::os_service_default)
  • build_retry_interval (Any) (defaults to: $::os_service_default)
  • default_connection_limit (Any) (defaults to: $::os_service_default)
  • admin_log_targets (Any) (defaults to: $::os_service_default)
  • administrative_log_facility (Any) (defaults to: $::os_service_default)
  • forward_all_logs (Any) (defaults to: $::os_service_default)
  • tenant_log_targets (Any) (defaults to: $::os_service_default)
  • user_log_facility (Any) (defaults to: $::os_service_default)
  • user_log_format (Any) (defaults to: $::os_service_default)
  • disable_local_log_storage (Any) (defaults to: $::os_service_default)
  • vrrp_advert_int (Any) (defaults to: $::os_service_default)
  • vrrp_check_interval (Any) (defaults to: $::os_service_default)
  • vrrp_fail_count (Any) (defaults to: $::os_service_default)
  • vrrp_success_count (Any) (defaults to: $::os_service_default)
  • vrrp_garp_refresh_interval (Any) (defaults to: $::os_service_default)
  • vrrp_garp_refresh_count (Any) (defaults to: $::os_service_default)
  • port_detach_timeout (Any) (defaults to: undef) 


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

class octavia::controller (
  $amp_active_retries                 = $::os_service_default,
  $amp_active_wait_sec                = $::os_service_default,
  $amp_flavor_id                      = '65',
  $amp_image_tag                      = $::os_service_default,
  $amp_image_owner_id                 = $::os_service_default,
  $amp_secgroup_list                  = $::os_service_default,
  $amp_boot_network_list              = $::os_service_default,
  $loadbalancer_topology              = $::os_service_default,
  $amphora_driver                     = $::os_service_default,
  $compute_driver                     = $::os_service_default,
  $network_driver                     = $::os_service_default,
  $volume_driver                      = $::os_service_default,
  $image_driver                       = $::os_service_default,
  $enable_ssh_access                  = true,
  $amp_ssh_key_name                   = 'octavia-ssh-key',
  $timeout_client_data                = $::os_service_default,
  $timeout_member_connect             = $::os_service_default,
  $timeout_member_data                = $::os_service_default,
  $timeout_tcp_inspect                = $::os_service_default,
  $controller_ip_port_list            = $::os_service_default,
  $connection_max_retries             = $::os_service_default,
  $connection_retry_interval          = $::os_service_default,
  $connection_logging                 = $::os_service_default,
  $active_connection_max_retries      = $::os_service_default,
  $active_connection_retry_interval   = $::os_service_default,
  $failover_connection_max_retries    = $::os_service_default,
  $failover_connection_retry_interval = $::os_service_default,
  $build_rate_limit                   = $::os_service_default,
  $build_active_retries               = $::os_service_default,
  $build_retry_interval               = $::os_service_default,
  $default_connection_limit           = $::os_service_default,
  $admin_log_targets                  = $::os_service_default,
  $administrative_log_facility        = $::os_service_default,
  $forward_all_logs                   = $::os_service_default,
  $tenant_log_targets                 = $::os_service_default,
  $user_log_facility                  = $::os_service_default,
  $user_log_format                    = $::os_service_default,
  $disable_local_log_storage          = $::os_service_default,
  $vrrp_advert_int                    = $::os_service_default,
  $vrrp_check_interval                = $::os_service_default,
  $vrrp_fail_count                    = $::os_service_default,
  $vrrp_success_count                 = $::os_service_default,
  $vrrp_garp_refresh_interval         = $::os_service_default,
  $vrrp_garp_refresh_count            = $::os_service_default,
  # DEPRECATED PARAMETERS
  $port_detach_timeout                = undef,
) inherits octavia::params {

  include octavia::deps
  include octavia::db

  if $port_detach_timeout != undef {
    warning('The octavia::controller::port_detach_timeout parameter is deprecated. \
Use the octavia::networking class instead')
  }
  include octavia::networking

  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 => $::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;
    '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;
    'health_manager/controller_ip_port_list'             : value => join(any2array($controller_ip_port_list), ',');
    '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/default_connection_limit'           : value => $default_connection_limit;
    '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/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;
  }
}