https://github.com/sous-chefs/haproxy
Development repository for the haproxy cookbook
https://github.com/sous-chefs/haproxy
chef chef-cookbook chef-resource hacktoberfest haproxy managed-by-terraform
Last synced: 6 months ago
JSON representation
Development repository for the haproxy cookbook
- Host: GitHub
- URL: https://github.com/sous-chefs/haproxy
- Owner: sous-chefs
- License: apache-2.0
- Created: 2012-03-14T18:14:11.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T10:37:46.000Z (over 1 year ago)
- Last Synced: 2024-04-14T11:03:41.304Z (over 1 year ago)
- Topics: chef, chef-cookbook, chef-resource, hacktoberfest, haproxy, managed-by-terraform
- Language: Ruby
- Homepage: https://supermarket.chef.io/cookbooks/haproxy
- Size: 972 KB
- Stars: 156
- Watchers: 35
- Forks: 251
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# haproxy Cookbook
[](https://github.com/sous-chefs/haproxy/actions?query=workflow%3Aci)
[](https://supermarket.chef.io/cookbooks/haproxy)
[](#backers)
[](#sponsors)
[](https://opensource.org/licenses/Apache-2.0)
Installs and configures HAProxy.
## Maintainers
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit [sous-chefs.org](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).
## Requirements
* HAProxy `stable` or `LTS`
* Chef 13.9+
### Platforms
This cookbook officially supports and is tested against the following platforms:
* debian: 9 & 10
* ubuntu: 20.04 & 21.04
* centos: 7 & 8
* centos-stream: 8
* fedora: latest
* amazonlinux: 2
PRs are welcome to add support for additional platforms.
### Examples
Please check for working examples in [the test cookbook](test/cookbooks/test).
## Common Resource Features
HAProxy has many configurable options available, this cookbook makes the most popular options available as resource properties.
If you wish to use a HAProxy property that is not listed the `extra_options` hash is available to take in any number of additional values.
For example, the ability to disable listeners is not provided out of the box. Further examples can be found in either `test/fixtures/recipes` or `spec/test/recipes`. If you have questions on how this works or would like to add more examples so it is easier to understand, please come talk to us on the [Chef Community Slack](http://community-slack.chef.io/) on the #sous-chefs channel.
```ruby
haproxy_listen 'disabled' do
bind '0.0.0.0:1337'
mode 'http'
extra_options('disabled': '')
end
```
The `extra_options` hash is of `String => String` or `String => Array`. When an `Array` value is provided. The values are looped over mapping the key to each value in the config.
For example:
```ruby
haproxy_listen 'default' do
extra_options(
'http-request' => [ 'set-header X-Public-User yes', 'del-header X-Bad-Header' ]
)
end
```
Becomes:
```haproxy
listen default
...
http-request set-header X-Public-User yes
http-request del-header X-Bad-Header
```
## Resources
* [haproxy_acl](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_acl.md)
* [haproxy_backend](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_backend.md)
* [haproxy_cache](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_cache.md)
* [haproxy_config_defaults](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_config_defaults.md)
* [haproxy_config_global](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_config_global.md)
* [haproxy_fastcgi](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_fastcgi.md)
* [haproxy_frontend](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_frontend.md)
* [haproxy_install](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_install.md)
* [haproxy_listen](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_listen.md)
* [haproxy_mailer](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_mailer.md)
* [haproxy_peer](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_peer.md)
* [haproxy_resolver](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_resolver.md)
* [haproxy_service](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_service.md)
* [haproxy_use_backend](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_use_backend.md)
* [haproxy_userlist](https://github.com/sous-chefs/haproxy/tree/master/documentation/haproxy_userlist.md)
## Configuration Validation
The `haproxy.cfg` file has a few specific rule orderings that will generate validation errors if not loaded properly. If using any combination of the below rules, avoid the errors by loading the rules via `extra_options` to specify the top down order as noted below in config file.
### frontend & listen
```haproxy
tcp-request connection
tcp-request session
tcp-request content
monitor fail
http-request
reqxxx (any req excluding reqadd, e.g. reqdeny, reqallow)
reqadd
redirect
use_backend
```
```ruby
extra_options(
'tcp-request' => 'connection set-src src,ipmask(24)',
'reqdeny' => '^Host:\ .*\.local',
'reqallow' => '^Host:\ www\.',
'use_backend' => 'dynamic'
)
```
### backend
```haproxy
http-request
reqxxx (any req excluding reqadd, e.g. reqdeny, reqallow)
reqadd
redirect
```
```ruby
extra_options(
'http-request' => 'set-path /%[hdr(host)]%[path]',
'reqdeny' => '^Host:\ .*\.local',
'reqallow' => '^Host:\ www\.',
'redirect' => 'dynamic'
)
```
## Contributors
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
### Backers
Thank you to all our backers!
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
