Defined Type: keepalived::lvs::virtual_server

Defined in:
manifests/lvs/virtual_server.pp

Overview

Define: keepalived::lvs::virtual_server

Configure a Linux Virtual Server with keepalived

Work in progress, supports:

- single IP/port virtual servers
- TCP_CHECK healthchecks

Parameters

Refer to keepalived’s documentation to understand the behaviour of these parameters

ip_address

Virtual server IP address.

port

Virtual sever IP port.

fwmark

Virtual Server firewall mark. (overrides ip_address and port) Default: not set

lb_algo

Must be one of rr, wrr, lc, wlc, lblc, sh, dh Default: not set.

delay_loop

Default: not set.

protocol

Default: TCP

lb_kind

Must be one of NAT, TUN, DR. Default: NAT

ha_suspend

Boolean. Default: false => not set in config.

alpha

Boolean. Default: false => not set in config.

omega

Boolean. Default: false => not set in config.

sh-port

Boolean. Default: false => not set in config.

sh-fallback

Boolean. Default: false => not set in config.

quorum

Integer. Defaults to unset => does not appear in config.

quorum_up

Script string. Defaults to unset => does not appear in config.

quorum_down

Script string. Defaults to unset => does not appear in config.

hysteresis

Integer. Defaults to unset => does not appear in config.

tcp_check

The TCP_CHECK to configure for real_servers. Should be a hash containing these keys:

[*connect_timeout*]

Default: unset => no TCP_CHECK configured.

real_server_options

One or more options to apply to all real_server blocks inside this virtual_server.

Example:

real_server_options => {
  inhibit_on_failure => true,
  SMTP_CHECK => {
    connect_timeout => 10
    host => {
      connect_ip => '127.0.0.1'
    }
  }
}

Default: unset => no default options

sorry_server

The sorry_server to define A hash with these keys:

[*ip_address*]
[*port*]
sorry_server_inhibit

Boolean. Default: false => not set in config.

real_servers

The real servers to balance to. An array of hashes. Hash keys:

[*ip_address*]
[*port*]       (if ommitted the port defaults to the VIP port)
collect_exported

Boolean. Automatically collect exported @@keepalived::lvs::real_servers with a virtual_server equal to the name/title of this resource. This allows you to easily export a real_server resource on each node in the pool. Defaults to true => collect exported real_servers

Parameters:

  • lb_algo (Enum['rr','wrr','lc','wlc','lblc','sh','dh'])
  • ip_address (Optional[Stdlib::IP::Address]) (defaults to: undef)
  • port (Optional[Stdlib::Port]) (defaults to: undef)
  • fwmark (Optional[Integer[1]]) (defaults to: undef)
  • alpha (Boolean) (defaults to: false)
  • collect_exported (Boolean) (defaults to: true)
  • delay_loop (Optional[Integer[1]]) (defaults to: undef)
  • ha_suspend (Boolean) (defaults to: false)
  • hysteresis (Optional[Integer[0]]) (defaults to: undef)
  • lb_kind (Enum['NAT','DR','TUN']) (defaults to: 'NAT')
  • omega (Boolean) (defaults to: false)
  • sh_port (Boolean) (defaults to: false)
  • sh_fallback (Boolean) (defaults to: false)
  • persistence_timeout (Optional[Integer[1]]) (defaults to: undef)
  • protocol (Enum['TCP','UDP']) (defaults to: 'TCP')
  • quorum (Optional[Integer[1]]) (defaults to: undef)
  • quorum_up (Optional[String[1]]) (defaults to: undef)
  • quorum_down (Optional[String[1]]) (defaults to: undef)
  • real_servers (Array[Hash]) (defaults to: [])
  • sorry_server (Optional[Struct[{ ip_address => Stdlib::IP::Address, port => Stdlib::Port }]]) (defaults to: undef)
  • sorry_server_inhibit (Boolean) (defaults to: false)
  • tcp_check (Optional[Hash]) (defaults to: undef)
  • real_server_options (Hash) (defaults to: {})
  • virtualhost (Optional[Stdlib::Fqdn]) (defaults to: undef) 


120
121
122
123
124
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
 
# File 'manifests/lvs/virtual_server.pp', line 120

define keepalived::lvs::virtual_server (
  Enum['rr','wrr','lc','wlc','lblc','sh','dh'] $lb_algo,
  Optional[Stdlib::IP::Address] $ip_address = undef,
  Optional[Stdlib::Port] $port = undef,
  Optional[Integer[1]] $fwmark = undef,
  Boolean $alpha = false,
  Boolean $collect_exported = true,
  Optional[Integer[1]] $delay_loop = undef,
  Boolean $ha_suspend = false,
  Optional[Integer[0]] $hysteresis = undef,
  Enum['NAT','DR','TUN'] $lb_kind = 'NAT',
  Boolean $omega = false,
  Boolean $sh_port = false,
  Boolean $sh_fallback = false,
  Optional[Integer[1]] $persistence_timeout = undef,
  Enum['TCP','UDP'] $protocol = 'TCP',
  Optional[Integer[1]] $quorum = undef,
  Optional[String[1]] $quorum_up = undef,
  Optional[String[1]] $quorum_down = undef,
  Array[Hash] $real_servers = [],
  Optional[Struct[{ ip_address => Stdlib::IP::Address, port => Stdlib::Port }]] $sorry_server = undef,
  Boolean $sorry_server_inhibit = false,
  Optional[Hash] $tcp_check = undef,
  Hash $real_server_options = {},
  Optional[Stdlib::Fqdn] $virtualhost = undef,
) {
  $_name = regsubst($name, '[:\/\n]', '')

  unless $fwmark {
    assert_type(Stdlib::Port, $port)
    assert_type(Stdlib::IP::Address, $ip_address)
  }

  if $tcp_check {
    warning('the $tcp_check argument is deprecated in favor of $real_server_options')
  }

  concat::fragment { "keepalived.conf_lvs_virtual_server_${_name}":
    target  => "${keepalived::config_dir}/keepalived.conf",
    content => template('keepalived/lvs_virtual_server.erb'),
    order   => "250-${_name}-000",
  }

  concat::fragment { "keepalived.conf_lvs_virtual_server_${_name}-footer":
    target  => "${keepalived::config_dir}/keepalived.conf",
    content => "}\n",
    order   => "250-${_name}-zzz",
  }

  if $collect_exported {
    Keepalived::Lvs::Real_server {
      options => $real_server_options,
    }
    Keepalived::Lvs::Real_server <<| virtual_server == $_name |>>
  }
}