haproxy Cookbook

Installs haproxy and prepares the configuration location.

Requirements

• Chef 12.1+

Platforms

• Ubuntu 12.04+
• RHEL 6+, CentOS6+
• RHEL 7+, CentOS7+
• Debian 8+

Attributes

• node['haproxy']['incoming_address'] - sets the address to bind the haproxy process on, 0.0.0.0 (all addresses) by default
• node['haproxy']['incoming_port'] - sets the port on which haproxy listens
• node['haproxy']['members'] - used by the default recipe to specify the member systems to add. Default

  [{
    "hostname" => "localhost",
    "ipaddress" => "127.0.0.1",
    "port" => 4000,
    "ssl_port" => 4000
  }, {
    "hostname" => "localhost",
    "ipaddress" => "127.0.0.1",
    "port" => 4001,
    "ssl_port" => 4001
  }]

• node['haproxy']['member_port'] - the port that member systems will be listening on if not otherwise specified in the members attribute, default 8080

• node['haproxy']['member_weight'] - the weight to apply to member systems if not otherwise specified in the members attribute, default 1

• node['haproxy']['app_server_role'] - used by the app_lb recipe to search for a specific role of member systems. Default webserver.

• node['haproxy']['balance_algorithm'] - sets the load balancing algorithm; defaults to roundrobin.

• node['haproxy']['enable_ssl'] - whether or not to create listeners for ssl, default false

• node['haproxy']['ssl_incoming_address'] - sets the address to bind the haproxy on for SSL, 0.0.0.0 (all addresses) by default

• node['haproxy']['ssl_member_port'] - the port that member systems will be listening on for ssl, default 8443

• node['haproxy']['ssl_incoming_port'] - sets the port on which haproxy listens for ssl, default 443

• node['haproxy']['httpchk'] - used by the app_lb recipe. If set, will configure httpchk in haproxy.conf

• node['haproxy']['ssl_httpchk'] - used by the app_lb recipe. If set and enable_ssl is true, will configure httpchk in haproxy.conf for the ssl_application section

• node['haproxy']['enable_admin'] - whether to enable the admin interface. default true. Listens on port 22002.

• node['haproxy']['admin']['address_bind'] - sets the address to bind the administrative interface on, 127.0.0.1 by default

• node['haproxy']['admin']['port'] - sets the port for the administrative interface, 22002 by default

• node['haproxy']['admin']['options'] - sets extras config parameters on the administrative interface, 'stats uri /' by default

• node['haproxy']['enable_stats_socket'] - controls haproxy socket creation, false by default

• node['haproxy']['stats_socket_path'] - location of haproxy socket, "/var/run/haproxy.sock" by default

• node['haproxy']['stats_socket']['user'] - user for haproxy socket, default is node['haproxy']['user']

• node['haproxy']['stats_socket']['group'] - group for haproxy socket, default is node['haproxy']['group']

• node['haproxy']['pid_file'] - the PID file of the haproxy process, used in the tuning recipe.

• node['haproxy']['global_options'] - global options, like tuning. Format must be of { 'option' => 'value' }; defaults to {}.

• node['haproxy']['defaults_options'] - an array of options to use for the config file's defaults stanza, default is ["httplog", "dontlognull", "redispatch"]

• node['haproxy']['defaults_timeouts']['connect'] - connect timeout in defaults stanza

• node['haproxy']['defaults_timeouts']['client'] - client timeout in defaults stanza

• node['haproxy']['defaults_timeouts']['server'] - server timeout in defaults stanza

• node['haproxy']['x_forwarded_for'] - if true, creates an X-Forwarded-For header containing the original client's IP address. This option disables KeepAlive.

• node['haproxy']['member_max_connections'] - the maxconn value to be set for each app server

• node['haproxy']['cookie'] - if set, use this to pin connection to the same server with a cookie.

• node['haproxy']['user'] - user that haproxy runs as

• node['haproxy']['group'] - group that haproxy runs as

• node['haproxy']['global_max_connections'] - in the app_lb config, set the global maxconn

• node['haproxy']['member_max_connections'] - the maxconn value to be set for each app server if not otherwise specified in the members attribute

• node['haproxy']['frontend_max_connections'] - in the app_lb config, set the the maxconn per frontend member

• node['haproxy']['frontend_ssl_max_connections'] - in the app_lb config, set the maxconn per frontend member using SSL

• node['haproxy']['install_method'] - determines which method is used to install haproxy, must be 'source' or 'package'. defaults to 'package'

• node['haproxy']['conf_dir'] - the location of the haproxy config file

• node['haproxy']['source']['version'] - the version of haproxy to install

• node['haproxy']['source']['url'] - the full URL to the haproxy source package

• node['haproxy']['source']['checksum'] - the checksum of the haproxy source package

• node['haproxy']['source']['prefix'] - the prefix used to make install haproxy

• node['haproxy']['source']['target_os'] - the target used to make haproxy

• node['haproxy']['source']['target_cpu'] - the target cpu used to make haproxy

• node['haproxy']['source']['target_arch'] - the target arch used to make haproxy

• node['haproxy']['source']['use_pcre'] - whether to build with libpcre support

• node['haproxy']['package']['version'] - the version of haproxy to install, default latest

• node['haproxy']['pool_members'] - updated by discovery to store node information

• node['haproxy']['conf_cookbook'] - used to update which cookbook holds the haproxy.cfg template

• node['haproxy']['conf_template_source'] - name of the haproxy.cfg template

Recipes

default

manual

Sets up haproxy using statically defined configuration.

app_lb

Uses chef search to set up haproxy creating a dynamically defined configuration. See Usage below.

_discovery

Helper recipe that finds nodes with a attribute defined role name using search. Sets node['haproxy']['pool_members']

tuning

Uses the community cpu cookbook's cpu_affinity LWRP to set affinity for the haproxy process.

install_package

Installs haproxy through the package manager. Used by the default and app_lb recipes.

install_source

Installs haproxy from source. Used by the default and app_lb recipes.

Providers

haproxy_lb

Configure a part of haproxy (frontend|backend|listen). It is used in manual and app_lb recipes to configure default frontends and backends. Several common options can be set as attributes of the LWRP. Others can always be set with the parameters attribute. For instance,

haproxy_lb 'rabbitmq' do
  bind '0.0.0.0:5672'
  mode 'tcp'
  servers (1..4).map do |i|
    "rmq#{i} 10.0.0.#{i}:5672 check inter 10s rise 2 fall 3"
  end
  parameters({
    'maxconn' => 20000,
    'balance' => 'roundrobin'
  })
end

which will be translated into:

listen rabbitmq'
  bind 0.0.0.0:5672
  mode tcp
  rmq1 10.0.0.1:5672 check inter 10s rise 2 fall 3
  rmq2 10.0.0.2:5672 check inter 10s rise 2 fall 3
  rmq3 10.0.0.3:5672 check inter 10s rise 2 fall 3
  rmq4 10.0.0.4:5672 check inter 10s rise 2 fall 3
  maxconn 20000
  balance roundrobin

All options can also be set in the parameters instead. In that case, you might want to provide an array to parameters attributes to avoid conflicts for options occuring several times.

haproxy_lb 'rabbitmq' do
  parameters([
    'bind 0.0.0.0:5672',
    'mode tcp',
    'rmq1 10.0.0.1:5672 check inter 10s rise 2 fall 3',
    'rmq2 10.0.0.2:5672 check inter 10s rise 2 fall 3',
    'rmq3 10.0.0.3:5672 check inter 10s rise 2 fall 3',
    'rmq4 10.0.0.4:5672 check inter 10s rise 2 fall 3',
    'maxconn' => 20000,
    'balance' => 'roundrobin'
  ])
end

which will give the same result.

Finally you can also configure frontends and backends by specify the type attribute of the resource. See example in the manual recipe.

Instead of using lwrp, you can use node['haproxy']['listeners'] to configure all kind of listeners (listen, frontend and backend)

haproxy_config

This provider is used to write the actual haproxy.cfg file to the system. Location of haproxy.cfg.erb template file can be adjusted to support wrapper cookbook customizations.

haproxy_config "Write Config" do
  conf_dir node['haproxy']['conf_dir']
  conf_cookbook node['haproxy']['conf_cookbook']
  conf_template_source node['haproxy']['conf_template_source']
end

haproxy

The haproxy LWRP allows for a more freeform method of configuration. It will map a given data structure into the proper configuration format, making it easier for adjustment and expansion.

haproxy 'myhaproxy' do
  config Mash.new(
    :global => {
      :maxconn => node[:haproxy][:global_max_connections],
      :user => node[:haproxy][:user],
      :group => node[:haproxy][:group]
    },
    :defaults => {
      :log => :global,
      :mode => :tcp,
      :retries => 3,
      :timeout => 5
    },
    :frontend => {
      :srvs => {
        :maxconn => node[:haproxy][:frontend_max_connections],
        :bind => "#{node[:haproxy][:incoming_address]}:#{node[:haproxy][:incoming_port]}",
        :default_backend => :backend_servers
      }
    },
    :backend => {
      :backend_servers => {
        :mode => :tcp,
        :server => [
          "an_node 192.168.99.9:9999" => {
            :weight => 1,
            :maxconn => node[:haproxy][:member_max_connections]
          }
        ]
      }
    }
  )
end

Usage

Use either the manual recipe or the app_lb recipe.

When using the manual recipe, the members attribute specifies the http application servers. If you wish to use the node['haproxy']['listeners'] attribute or haproxy_lb lwrp instead then set node['haproxy']['enable_default_http'] to false.

"haproxy" => {
  "members" => [{
    "hostname" => "appserver1",
    "ipaddress" => "123.123.123.1",
    "port" => 8000,
    "ssl_port" => 8443,
    "weight" => 1,
    "max_connections" => 100
  }, {
    "hostname" => "appserver2",
    "ipaddress" => "123.123.123.2",
    "port" => 8000,
    "ssl_port" => 8443,
    "weight" => 1,
    "max_connections" => 100
  }, {
    "hostname" => "appserver3",
    "ipaddress" => "123.123.123.3",
    "port" => 8000,
    "ssl_port" => 8443,
    "weight" => 1,
    "max_connections" => 100
  }]
}

Note that the following attributes are optional

• port will default to the value of node['haproxy']['member_port']
• ssl_port will default to the value of node['haproxy']['ssl_member_port']
• weight will default to the value of node['haproxy']['member_weight']
• max_connections will default to the value of node['haproxy']['member_max_connections']

The app_lb recipe is designed to be used with the application cookbook, and provides search mechanism to find the appropriate application servers. Set this in a role that includes the haproxy::app_lb recipe. For example,

name 'load_balancer'
description 'haproxy load balancer'
run_list('recipe[haproxy::app_lb]')
override_attributes(
  'haproxy' => {
    'app_server_role' => 'webserver'
  }
)

The search uses the node's chef_environment. For example, create environments/production.rb, then upload it to the server with knife

License & Authors

• Author:: Joshua Timberman (joshua@chef.io)
• Author:: Aaron Baer (aaron@hw-ops.com)
• Author:: Justin Kolberg (justin@hw-ops.com)

Copyright:: Heavy Water Operations, LLC.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.