Defined Type: haproxy::frontend

Defined in:
manifests/frontend.pp

Summary

This type will setup a frontend service configuration block inside the haproxy.cfg file on an haproxy load balancer.

Overview

Authors

Gary Larizza <gary@puppetlabs.com>

Note:

Currently requires the puppetlabs/concat module on the Puppet Forge and uses storeconfigs on the Puppet Server to export/collect resources from all balancer members.

Examples:

Exporting the resource for a balancer member:

haproxy::frontend { 'puppet00':
  ipaddress    => $::ipaddress,
  ports        => [18140],
  mode         => 'tcp',
  bind_options => 'accept-proxy',
  options      => {
    'option'   => [
      'tcplog',
      'accept-invalid-http-request',
    ],
    'timeout client' => '30s',
    'balance'    => 'roundrobin'
  },
}

Parameters:

  • section_name (String[1]) (defaults to: $name) —

    This name goes right after the ‘frontend’ statement in haproxy.cfg Default: $name (the namevar of the resource).

  • ports (Optional[Haproxy::Ports]) (defaults to: undef) —

    Ports on which the proxy will listen for connections on the ip address

    specified in the ipaddress parameter. Accepts either a single
comma-separated string or an array of strings which may be ports or
hyphenated port ranges.
  • bind (Optional[Hash]) (defaults to: undef) —

    Set of ip addresses, port and bind options $bind = { ‘10.0.0.1:80’ => [‘ssl’, ‘crt’, ‘/path/to/my/crt.pem’] }

  • ipaddress (Optional[Variant[String, Array]]) (defaults to: undef) —

    The ip address the proxy binds to.

    Empty addresses, '*', and '0.0.0.0' mean that the proxy listens
to all valid addresses on the system.
  • mode (Optional[Enum['tcp', 'http', 'health']]) (defaults to: undef) —

    The mode of operation for the frontend service. Valid values are undef,

    'tcp', 'http', and 'health'.
  • description (Optional[String]) (defaults to: undef) —

    Allows to add a sentence to describe the related object in the HAProxy HTML stats page. The description will be printed on the right of the object name it describes. Usefull in huge environments

  • bind_options (Optional[Array]) (defaults to: undef) —

    (Deprecated) An array of options to be specified after the bind declaration

    in the listening serivce's configuration block.
  • options (Variant[Hash, Array[Hash]]) (defaults to: { 'option' => [ 'tcplog', ], }) —

    A hash of options that are inserted into the frontend service

    configuration block.
  • sort_options_alphabetic (Boolean) (defaults to: true) —

    Sort options either alphabetic or custom like haproxy internal sorts them. Defaults to true.

  • defaults (Optional[String]) (defaults to: undef) —

    Name of the defaults section this backend will use. Defaults to undef which means the global defaults section will be used.

  • defaults_use_backend (Boolean) (defaults to: true) —

    If defaults are used and a default backend is configured use the backend name for ordering. This means that the frontend is placed in the configuration file before the backend configuration. Defaults to true.

  • config_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    Optional. Path of the config file where this entry will be added. Assumes that the parent directory exists. Default: $haproxy::params::config_file

  • collect_exported (Boolean) (defaults to: true) —

    Boolean. Default true

  • instance (String) (defaults to: 'haproxy') —

    Optional. Defaults to ‘haproxy’



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
 
# File 'manifests/frontend.pp', line 93

define haproxy::frontend (
  Optional[Haproxy::Ports]                $ports                    = undef,
  Optional[Variant[String, Array]]        $ipaddress                = undef,
  Optional[Hash]                          $bind                     = undef,
  Optional[Enum['tcp', 'http', 'health']] $mode                     = undef,
  Boolean                                 $collect_exported         = true,
  Variant[Hash, Array[Hash]]              $options                  = {
    'option'                                    => [
      'tcplog',
    ],
  },
  String                                  $instance                 = 'haproxy',
  String[1]                               $section_name             = $name,
  Boolean                                 $sort_options_alphabetic  = true,
  Optional[String]                        $description              = undef,
  Optional[String]                        $defaults                 = undef,
  Boolean                                 $defaults_use_backend     = true,
  Optional[Stdlib::Absolutepath]          $config_file              = undef,
  # Deprecated
  Optional[Array]                         $bind_options             = undef,
) {
  if $ports and $bind {
    fail('The use of $ports and $bind is mutually exclusive, please choose either one')
  }
  if $ipaddress and $bind {
    fail('The use of $ipaddress and $bind is mutually exclusive, please choose either one')
  }
  if $bind_options {
    warning('The $bind_options parameter is deprecated; please use $bind instead')
  }

  include haproxy::params

  if $instance == 'haproxy' {
    $instance_name = 'haproxy'
    $_config_file = pick($config_file, $haproxy::config_file)
  } else {
    $instance_name = "haproxy-${instance}"
    $_config_file = pick($config_file, inline_template($haproxy::params::config_file_tmpl))
  }

  include haproxy::globals
  $_sort_options_alphabetic = pick($sort_options_alphabetic, $haproxy::globals::sort_options_alphabetic)

  if $defaults == undef {
    $order = "15-${section_name}-00"
  } else {
    if $defaults_use_backend and 'default_backend' in $options {
      $order = "25-${defaults}-${options['default_backend']}-00-${section_name}"
    } else {
      $order = "25-${defaults}-${section_name}-00"
    }
  }

  $parameters = {
    'section_name'             => $section_name,
    'bind'                     => $bind,
    'ipaddress'                => $ipaddress,
    'ports'                    => $ports,
    'bind_options'             => $bind_options,
    'mode'                     => $mode,
    'description'              => $description,
    'options'                  => $options,
    '_sort_options_alphabetic' => $_sort_options_alphabetic,
  }

  # Template uses: $section_name, $ipaddress, $ports, $options
  concat::fragment { "${instance_name}-${section_name}_frontend_block":
    order   => $order,
    target  => $_config_file,
    content => epp('haproxy/haproxy_frontend_block.epp', $parameters),
  }
}