confdroid_haproxy/README.md

[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_haproxy)](https://pipelines.confdroid.com/job/cd_haproxy/)|

[[_TOC_]]

# Synopsis

`HA Proxy` is a very powerful and popular open source load balancer to balance
incoming requests between multiple instances of web-, application- or database
servers etc.

`cd_haproxy` automates installation and configuration of `HA proxy` 
including self-healing, monitoring and firewall etc.

# WARNING

`**__!!! Attention: Never use this puppet module on systems which have been
previously configured manually. It is impossible to predict how and what would
have been configured, hence previous configurations outside the scope of this
module may be overwritten! Automated configurations require a test environment
to verify that the module suits the purpose intended by the user, as well as
tune the parameters, before deploying into live production!!! __**`

# Features

INSTALLATION
* install rpm binaries

CONFIGURATION
* manage haproxy user
* manage directories (file system permissions, selinux context)
* manage files (file system permissions, content, selinux context)
* manage proxy instances through a define
  * frontend options
  * backend options
  * ACL options

SERVICE
* manage haproxy service
* restart service after changes in the configuration

# [Puppet Documentation](docs/index.html)

# Dependencies

All dependencies must be included in the catalogue.

* [cd_resources](https://gitlab.confdroid.com/12WW1160/cd_resources)
  for managing yum base repos
* [cd_concat](https://gitlab.confdroid.com/12ww1160/cd_concat) or
  [concat](https://github.com/puppetlabs/puppetlabs-concat)
  for managing file fragments

# Deployment

## native Puppet deployment

via site.pp or nodes.pp

```
node 'example.example.net' {
  include cd_haproxy
}
```
## through Foreman:

Add params.pp to the host or hostgroup.

See [more details about class deployment on confdroid.com]
(https://confdroid.com/2017/05/deploying-our-puppet-modules/).

# Documentation

## Parameters

The parameters are defined and described in `params.pp`. The documentation is
provided via `puppet strings` in HTML format, please see `doc/index.html`
via web browser.

# Proxy Configuration

## Via Define

The proxy instances are configured in `/etc/haproxy/haproxy.cfg`, which is
concatenated from various templates through a define in this puppet module.
In order to create proxy instances, you will need an external class, which
addresses the define, like so:

```
  cd_haproxy::server::proxy { 'testing':
    haproxy_fqdn    =>  'node.example.net',
    frontend_name   =>  'test01-frontend',
    frontend_mode   =>  'http',
    acl_rule        =>  ['too_fast fe_sess_rate ge 10',
                          'network_allowed src 0.0.0.0/0'],
    backend_name    =>  'test01-backend',
  }
```

This class should be placed in an internal  configuration repo specific
to your environment.

# SELINUX

All files and directories are configured with correct selinux context.
If selinux is disabled, these contexts are ignored.

# Known Problems

# Support

* OS: CentOS 7
* Puppet 5.x


# Tests

* Puppet Lint
  * excluded tests:
    * `--no-class_inherits_from_params_class-check`:relevant only to 
      non-supported outdated puppet versions
    * `--no-variable_scope-check`: not applicable as we are inheriting
      parameters from the params class. the lint check does not distinguish
      between facts and inherited parameters.
    * `--no-80chars-check`: it is not always possible to stay within 
      80 characters, although typically only occurring on the 
      parameter vault `params.pp`.
    * `--no-arrow_alignment-check`: this check leads to actually not having 
      easily readable arrow alignments, as this checks `per block`, 
      not per class.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files


# Contact Us

[contact Us](https://confdroid.com/contact/)

# Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom 
configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing
in designated environments  (i.e. lab or development environments) for
parameter tuning etc. before deploying into production environments.