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

add spellcheck

Browse Source
This commit is contained in:
12WW1160
2021-01-02 20:17:09 +01:00
parent 05189b9217
commit fe97a34c42
2 changed files with 87 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Jenkinsfile vendored
View File

@@ -78,6 +78,16 @@ pipeline {
}
}
stage('markdown-lint') {
steps {
sh '''
source /opt/rh/rh-ruby27/enable
mdl README.md
mdl docs/
'''
}
}
stage('create Puppet documention') {
steps {
sh '/opt/puppetlabs/bin/puppet strings'

137
README.md
View File

@@ -1,33 +1,27 @@
[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_haproxy)](https://pipelines.confdroid.com/job/cd_haproxy/)|
### 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.
[[_TOC_]]
`cd_haproxy` automates installation and configuration of `HA proxy` including self-healing, monitoring and firewall etc.
# Synopsis
### 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!!! __**`
`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.
### Table of Contents
* [Features](#features)
* [Repo Structure](https://gitlab.confdroid.com/12WW1160/cd_haproxy/blob/master/REPOSTRUCTURE.md)
* [ Repo Documentation](#repo-documentation)
* [Dependencies](#dependencies)
* [Deployment](#deployment)
* [native Puppet deployment](#native-puppet-deployment)
* [through Foreman](#through-foreman)
* [Parameters](#parameters)
* [Mandatory Parameters](#mandatory-parameters)
* [Optional Parameters](#optional-parameters)
* [SELINUX](#selinux)
* [Known Problems](#known-problems)
* [Support](#support)
* [Tests](#tests)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)
`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
### Features
INSTALLATION
* install rpm binaries
@@ -44,21 +38,23 @@ SERVICE
* manage haproxy service
* restart service after changes in the configuration
### Repo Structure
Repostructure has moved to REPOSTRUCTURE.md in repo.
# Repo Documentation
### Repo Documentation
See the full Puppet documentation in 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://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
# Deployment
##### native Puppet deployment
## native Puppet deployment
via site.pp or nodes.pp
@@ -67,26 +63,30 @@ 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.
## through Foreman:
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
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 following parameters are editable via params.pp or through ENC (**__recommended__**). Values changed will take immediate effect at next puppet run. Services will be restarted where neccessary.
# Documentation
The [full list of Parameters](https://confdroid.com/2017/08/cd_haproxy-parameters/) is available [here](https://confdroid.com/2017/08/cd_haproxy-parameters/) and in the docs folder in the software repo.
## Parameters
#### Mandatory 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.
* `hy_host_fqdn`: Specify the FQDN of the host(s) where HA proxy should be running. The module will install it only on the host in question.
# Proxy Configuration
#### Optional Parameters
## Via Define
### 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:
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':
@@ -99,33 +99,50 @@ In order to create proxy instances, you will need an external class, which addre
}
```
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.
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.
# SELINUX
### Known Problems
All files and directories are configured with correct selinux context.
If selinux is disabled, these contexts are ignored.
# Known Problems
# Support
### Support
* OS: CentOS 7
* Puppet 5.x
### Tests
# Tests
* Puppet Lint
* excluded tests:
* `--no-class_inherits_from_params_class-check`:relavant 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.
* `--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
easily readable arrow alignments, as this checks `per block`,
not per class.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code as this causes problems with PuppetDB (see tests/UTF_Files)
### Contact Us
* Test for unwanted UTF8 files in the Puppet code as this causes problems
with PuppetDB (see tests/UTF_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.
# 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.