confdroid/confdroid_haproxy
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

TODO - adjust README

Browse Source
This commit is contained in:
Arne Teuke
2021-09-09 13:01:04 +02:00
parent 8952353d50
commit 54a067bb5c
1 changed files with 47 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
README.md
View File

@@ -1,26 +1,21 @@
[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_haproxy)](https://pipelines.confdroid.com/job/cd_haproxy/)|
# Readme
[[_TOC_]]
|`cd_haproxy`| 1.0.3.0 | [![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_haproxy)](https://pipelines.confdroid.com/job/cd_haproxy/)|
# Synopsis
[[_TOC]]
`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.
## Synopsis
`cd_haproxy` automates installation and configuration of `HA proxy`
including self-healing, monitoring and firewall etc.
`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.
# WARNING
`cd_haproxy` automates installation and configuration of `HA proxy` including self-healing, monitoring and firewall etc.
`**__!!! 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!!! __**`
## WARNING
# Features
`**__!!! 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
@@ -36,59 +31,47 @@ CONFIGURATION
* backend options
* ACL options
SERVICE
* manage haproxy service
* restart service after changes in the configuration
# [Puppet Documentation](docs/index.html)
# Dependencies
## 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
* [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
## Deployment
## native Puppet deployment
* native Puppet deployment
via site.pp or nodes.pp
```
```bash
node 'example.example.net' {
include cd_haproxy
}
```
* through Foreman:
## through Foreman
In order to apply parameters through Foreman, **__cd_haproxy::params__** must be added to the host or hostgroup in question.
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/).
See [details](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.
The parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.
# Proxy Configuration
## 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:
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',
@@ -99,48 +82,41 @@ addresses the define, like so:
}
```
This class should be placed in an internal configuration repo specific
to your environment.
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
## SELINUX
All files and directories are configured with correct selinux context.
If selinux is disabled, these contexts are ignored.
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
# Known Problems
## Known Problems
# Support
## Support
* OS: CentOS 7
* Puppet 5.x
* Puppet 5
# Tests
## 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.
* `--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
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
* Markdown-lint
* Spellcheck
* Sonar Quality Gate
# Contact Us
## Contact Us
[contact Us](https://confdroid.com/contact/)
# Disclaimer
## Disclaimer
ConfDroid as entity is 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.
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.