Add haproxy::instance for the creation of multiple instances of haproxy on a host. See [MODULES-1783]

  * New Define Resource Type: haproxy::instance
  * New Define Resource Type: haproxy::instance_service
  * Class[haproxy] is now a wrapper that calls haproxy::instance
  * Add "instance" parameter to all public defines.
  * All private classes become private defined resource types.
  * "inherts params" no longer used for classes that are now defines
  * Documentation updated, examples added
  * Spec tests updated and new tests added
  * Upgrade to stdlib 3.2.0
  * Upgrade to concat 1.2.3

Author: tlimoncelli

.fixtures.yml

@@ -5,6 +5,6 @@ fixtures:
       ref: '1.2.3'
     stdlib:
       repo: "git://github.com/puppetlabs/puppetlabs-stdlib.git"
-      ref: '2.4.0'
+      ref: '3.2.0'
   symlinks:
     haproxy: "#{source_dir}"

CHANGELOG.md

@@ -1,3 +1,17 @@
+## 2015-07-15 - Supported Release 1.3.0
+### Summary
+This release adds puppet 4 support, and adds the ability to specify the order
+of option entries for `haproxy::frontend` and `haproxy::listen` defined
+resources.
+
+#### Features
+- Adds puppet 4 compatibility
+- Updated readme
+- Gentoo compatibility
+- Suse compatibility
+- Add ability for frontend and listen to be ordered
+
+
 ##2015-03-10 - Supported Release 1.2.0
 ###Summary
 This release adds flexibility for configuration of balancermembers and bind settings, and adds support for configuring peers. This release also renames the `tests` directory to `examples`

Gemfile

@@ -28,6 +28,7 @@ group :system_tests do
     gem 'beaker-rspec',  :require => false
   end
   gem 'serverspec',    :require => false
+  gem 'beaker-puppet_install_helper', :require => false
 end
 
 

README.md

@@ -15,9 +15,9 @@
 #
 # === Parameters
 #
-# [*name*]
-#   The namevar of the defined resource type is the backend service's name.
+# [*section_name*]
 #    This name goes right after the 'backend' statement in haproxy.cfg
+#    Default: $name (the namevar of the resource).
 #
 # [*options*]
 #   A hash of options that are inserted into the backend configuration block.
@@ -57,22 +57,32 @@
       'ssl-hello-chk'
     ],
     'balance' => 'roundrobin'
-  }
+  },
+  $instance         = 'haproxy',
+  $section_name     = $name,
 ) {
+  if defined(Haproxy::Listen[$section_name]) {
+    fail("An haproxy::listen resource was discovered with the same name (${section_name}) which is not supported")
+  }
 
-  if defined(Haproxy::Listen[$name]) {
-    fail("An haproxy::listen resource was discovered with the same name (${name}) which is not supported")
+  include haproxy::params
+  if $instance == 'haproxy' {
+    $instance_name = 'haproxy'
+    $config_file = $haproxy::params::config_file
+  } else {
+    $instance_name = "haproxy-${instance}"
+    $config_file = inline_template($haproxy::params::config_file_tmpl)
   }
 
-  # Template uses: $name, $ipaddress, $ports, $options
-  concat::fragment { "${name}_backend_block":
-    order   => "20-${name}-00",
-    target  => $::haproxy::config_file,
+  # Template uses: $section_name, $ipaddress, $ports, $options
+  concat::fragment { "${instance_name}-${section_name}_backend_block":
+    order   => "20-${section_name}-00",
+    target  => $config_file,
     content => template('haproxy/haproxy_backend_block.erb'),
   }
 
   if $collect_exported {
-    haproxy::balancermember::collect_exported { $name: }
+    haproxy::balancermember::collect_exported { $section_name: }
   }
   # else: the resources have been created and they introduced their
   # concat fragments. We don't have to do anything about them.

manifests/backend.pp

@@ -16,10 +16,6 @@
 #
 # === Parameters
 #
-# [*name*]
-#   The title of the resource is arbitrary and only utilized in the concat
-#    fragment name.
-#
 # [*listening_service*]
 #   The haproxy service's instance name (or, the title of the
 #    haproxy::listen resource). This must match up with a declared
@@ -93,14 +89,24 @@
   $ipaddresses  = $::ipaddress,
   $ensure       = 'present',
   $options      = '',
-  $define_cookies = false
+  $define_cookies = false,
+  $instance     = 'haproxy',
 ) {
 
+  include haproxy::params
+  if $instance == 'haproxy' {
+    $instance_name = 'haproxy'
+    $config_file = $haproxy::params::config_file
+  } else {
+    $instance_name = "haproxy-${instance}"
+    $config_file = inline_template($haproxy::params::config_file_tmpl)
+  }
+
   # Template uses $ipaddresses, $server_name, $ports, $option
-  concat::fragment { "${listening_service}_balancermember_${name}":
+  concat::fragment { "${instance_name}-${listening_service}_balancermember_${name}":
     ensure  => $ensure,
     order   => "20-${listening_service}-01-${name}",
-    target  => $::haproxy::config_file,
+    target  => $config_file,
     content => template('haproxy/haproxy_balancermember.erb'),
   }
 }

manifests/balancermember.pp

@@ -1,34 +1,66 @@
 # Private class
-class haproxy::config inherits haproxy {
+define haproxy::config (
+  $instance_name,
+  $config_file,
+  $global_options,
+  $defaults_options,
+  $config_dir = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
+  $custom_fragment = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
+  $merge_options = $haproxy::merge_options,
+) {
   if $caller_module_name != $module_name {
     fail("Use of private class ${name} by ${caller_module_name}")
   }
 
-  concat { $haproxy::config_file:
+  if $merge_options {
+    $_global_options   = merge($haproxy::params::global_options, $global_options)
+    $_defaults_options = merge($haproxy::params::defaults_options, $defaults_options)
+  } else {
+    $_global_options   = $global_options
+    $_defaults_options = $defaults_options
+    warning("${module_name}: The \$merge_options parameter will default to true in the next major release. Please review the documentation regarding the implications.")
+  }
+
+  if $config_dir != undef {
+    file { $config_dir:
+      ensure => directory,
+      owner  => 'root',
+      group  => 'root',
+      mode   => '0755',
+    }
+  }
+
+  if $config_file != undef {
+    $_config_file = $config_file
+  } else {
+    $_config_file = $haproxy::config_file
+  }
+
+  concat { $_config_file:
     owner => '0',
     group => '0',
     mode  => '0644',
   }
 
   # Simple Header
-  concat::fragment { '00-header':
-    target  => $haproxy::config_file,
+  concat::fragment { "${instance_name}-00-header":
+    target  => $config_file,
     order   => '01',
     content => "# This file managed by Puppet\n",
   }
 
-  # Template uses $global_options, $defaults_options
-  concat::fragment { 'haproxy-base':
-    target  => $haproxy::config_file,
+  # Template uses $_global_options, $_defaults_options, $custom_fragment
+  concat::fragment { "${instance_name}-haproxy-base":
+    target  => $config_file,
     order   => '10',
-    content => template('haproxy/haproxy-base.cfg.erb'),
+    content => template("${module_name}/haproxy-base.cfg.erb"),
   }
 
-  if $haproxy::global_options['chroot'] {
-    file { $haproxy::global_options['chroot']:
+  if $_global_options['chroot'] {
+    file { $_global_options['chroot']:
       ensure => directory,
-      owner  => $haproxy::global_options['user'],
-      group  => $haproxy::global_options['group'],
+      owner  => $_global_options['user'],
+      group  => $_global_options['group'],
     }
   }
 }

manifests/config.pp

@@ -11,9 +11,9 @@
 #
 # === Parameters
 #
-# [*name*]
-#   The namevar of the defined resource type is the frontend service's name.
+# [*section_name*]
 #    This name goes right after the 'frontend' statement in haproxy.cfg
+#    Default: $name (the namevar of the resource).
 #
 # [*ports*]
 #   Ports on which the proxy will listen for connections on the ip address
@@ -56,7 +56,7 @@
 #        'tcplog',
 #        'accept-invalid-http-request',
 #      ],
-#      'timeout client' => '30',
+#      'timeout client' => '30s',
 #      'balance'    => 'roundrobin'
 #    },
 #  }
@@ -76,10 +76,11 @@
       'tcplog',
     ],
   },
+  $instance         = 'haproxy',
+  $section_name     = $name,
   # Deprecated
-  $bind_options     = '',
+  $bind_options     = undef,
 ) {
-
   if $ports and $bind {
     fail('The use of $ports and $bind is mutually exclusive, please choose either one')
   }
@@ -92,10 +93,20 @@
   if $bind {
     validate_hash($bind)
   }
-  # Template uses: $name, $ipaddress, $ports, $options
-  concat::fragment { "${name}_frontend_block":
-    order   => "15-${name}-00",
-    target  => $::haproxy::config_file,
+
+  include haproxy::params
+  if $instance == 'haproxy' {
+    $instance_name = 'haproxy'
+    $config_file = $haproxy::params::config_file
+  } else {
+    $instance_name = "haproxy-${instance}"
+    $config_file = inline_template($haproxy::params::config_file_tmpl)
+  }
+
+  # Template uses: $section_name, $ipaddress, $ports, $options
+  concat::fragment { "${instance_name}-${section_name}_frontend_block":
+    order   => "15-${section_name}-00",
+    target  => $config_file,
     content => template('haproxy/haproxy_frontend_block.erb'),
   }
 }

manifests/frontend.pp

@@ -12,17 +12,26 @@
 # === Parameters
 #
 # [*package_ensure*]
-#   Chooses whether the haproxy package should be installed or uninstalled. Defaults to 'present'
+#   Chooses whether the haproxy package should be installed or uninstalled.
+#   Defaults to 'present'
 #
 # [*package_name*]
 #   The package name of haproxy. Defaults to 'haproxy'
+#   NOTE: haproxy::instance has a different default.
 #
 # [*service_ensure*]
 #   Chooses whether the haproxy service should be running & enabled at boot, or
 #   stopped and disabled at boot. Defaults to 'running'
 #
 # [*service_manage*]
-#   Chooses whether the haproxy service state should be managed by puppet at all. Defaults to true
+#   Chooses whether the haproxy service state should be managed by puppet at
+#   all. Defaults to true
+#
+# [*service_options*]
+#   Contents for the `/etc/defaults/haproxy` file on Debian. Defaults to "ENABLED=1\n" on Debian, and is ignored on other systems.
+#
+# [*service_options*]
+#   Contents for the `/etc/defaults/haproxy` file on Debian. Defaults to "ENABLED=1\n" on Debian, and is ignored on other systems.
 #
 # [*global_options*]
 #   A hash of all the haproxy global options. If you want to specify more
@@ -36,6 +45,12 @@
 #    options as an array and you will get a line for each of them in the
 #    resultant haproxy.cfg file.
 #
+# [*merge_options*]
+#   Whether to merge the user-supplied `global_options`/`defaults_options`
+#   hashes with their default values set in params.pp. Merging allows to change
+#   or add options without having to recreate the entire hash. Defaults to
+#   false, but will default to true in future releases.
+#
 #[*restart_command*]
 #   Command to use when restarting the on config changes.
 #    Passed directly as the <code>'restart'</code> parameter to the service resource.
@@ -83,8 +98,10 @@
   $package_name     = $haproxy::params::package_name,
   $service_ensure   = 'running',
   $service_manage   = true,
+  $service_options  = $haproxy::params::service_options,
   $global_options   = $haproxy::params::global_options,
   $defaults_options = $haproxy::params::defaults_options,
+  $merge_options    = $haproxy::params::merge_options,
   $restart_command  = undef,
   $custom_fragment  = undef,
   $config_file      = $haproxy::params::config_file,
@@ -101,6 +118,13 @@
   }
   validate_string($package_name,$package_ensure)
   validate_bool($service_manage)
+  validate_bool($merge_options)
+  validate_string($service_options)
+
+  # NOTE: These deprecating parameters are implemented in this class,
+  # not in haproxy::instance.  haproxy::instance is new and therefore
+  # there should be no legacy code that uses these deprecated
+  # parameters.
 
   # To support deprecating $enable
   if $enable != undef {
@@ -125,17 +149,18 @@
     $_service_manage = $service_manage
   }
 
-  if $_package_ensure == 'absent' or $_package_ensure == 'purged' {
-    anchor { 'haproxy::begin': }
-    ~> class { 'haproxy::service': }
-    -> class { 'haproxy::config': }
-    -> class { 'haproxy::install': }
-    -> anchor { 'haproxy::end': }
-  } else {
-    anchor { 'haproxy::begin': }
-    -> class { 'haproxy::install': }
-    -> class { 'haproxy::config': }
-    ~> class { 'haproxy::service': }
-    -> anchor { 'haproxy::end': }
+  haproxy::instance{ $title:
+    package_ensure   => $_package_ensure,
+    package_name     => $package_name,
+    service_ensure   => $_service_ensure,
+    service_manage   => $_service_manage,
+    global_options   => $global_options,
+    defaults_options => $defaults_options,
+    restart_command  => $restart_command,
+    custom_fragment  => $custom_fragment,
+    config_file      => $config_file,
+    merge_options    => $merge_options,
+    service_options  => $service_options,
   }
+
 }

manifests/init.pp

@@ -1,12 +1,17 @@
 # Private class
-class haproxy::install inherits haproxy {
+define haproxy::install (
+  $package_ensure,
+  $package_name = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
+) {
   if $caller_module_name != $module_name {
     fail("Use of private class ${name} by ${caller_module_name}")
   }
 
-  package { $haproxy::package_name:
-    ensure => $haproxy::_package_ensure,
-    alias  => 'haproxy',
+  if $package_name != undef {
+    package { $package_name:
+      ensure => $package_ensure,
+      alias  => 'haproxy',
+    }
   }
 
   # Create default configuration directory, gentoo portage does not create it