confdroid_haproxy/README.md

# Readme

|`cd_haproxy`| 1.0.3.0 | [![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 balanacer 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 previuos 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

## Dependencies

All dependencies must be included in the catalogue.

* [cd_resources](https://sourcecode.confdroid.com/12WW1160/cd_resources) for managing yum base repos
* [cd_concat](https://sourcecode.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

```bash
node 'example.example.net' {
  include cd_haproxy
}
```

* through Foreman:

In order to apply parameters through Foreman, **__cd_haproxy::params__** must be added to the host or hostgroup in question.

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

## Parameters

The parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.

## Proxy Configuration

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:

```bash
  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 allows the puppet module to create the sections in the configuration file as required. The haproxy service will be restarted after the changes in the configuration file are made.
`haproxy_fqdn` **__must__** contain the fqdn of the haproxy **__server__** where this should be configured, otherwise the templates are not being populated.
Multiple ACLs need to be added as array, and will create one line each.

## 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

## 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 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 am easily readable arrow alignment, as this checks `per block`, not per class.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
* Markdown-lint
* Spellcheck
* Sonar Quality Gate

## 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.