Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
- Puppet >= 6.1.0 < 8.0.0
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'ploperations-haproxy_consul', '2.0.0'Learn more about managing modules with a PuppetfileDocumentation
haproxy_consul
Description
This module provides helpers for using Consul with HAProxy. In particular, it provides:
- a simplified way to make your Consul server listen on port 53 via the
dns_on_53class - a reusable block of code for setting up connection validation between HAProxy and somthing using your Puppet CA via the
puppet_ca_filesclass - a defined type named
resolverthat sets up a resolver in HAProxy that points at your Consul cluster - a defined type named
server_tempaltethat drastically reduces the work of creating the resources needed to front services registered in Consul
Requirements and Impact
This module will modify your HAProxy configs and can add firewall rules to your Consul server. A working Consul cluster is required also (a single node is fine).
Usage
See REFERENCE.md for examples of how to use the helpers provided by this module.
Reference
This module is documented via
pdk bundle exec puppet strings generate --format markdown.
Please see REFERENCE.md for more info.
Changelog
CHANGELOG.md is generated prior to each release via
pdk bundle exec rake changelog. This proecss relies on labels that are applied
to each pull request.
Limitations
This module assumes you are running HAProxy on *nix.
Contributing
Pull requests are welcome!
Reference
Table of Contents
Classes
haproxy_consul::dns_on_53: Forward port 53 to Consul DNS on port 8600haproxy_consul::puppet_ca_files: Setup connection validation via Puppet CA
Defined types
haproxy_consul::resolver: Generates a HAProxy resolver backed by Consulhaproxy_consul::server_template: Creates both a HAProxy listen and balancemenber resource
Classes
haproxy_consul::dns_on_53
Add firewall rules that let you hit Consul's DNS interface on the standard port (53), without running Consul as root, and while preserving access on its default port of 8600.
@see: https://www.consul.io/docs/guides/forwarding.html#iptables-setup
Examples
# applied only on Consul servers
include haproxy_consul::dns_on_53
haproxy_consul::puppet_ca_files
Setup connection validation via Puppet CA by copying the Puppet CA and CRL into a place that HAProxy can access to us for connection validation
Examples
include haproxy_consul::puppet_ca_files
Parameters
The following parameters are available in the haproxy_consul::puppet_ca_files class:
haproxy_cert_dir
Data type: Stdlib::Unixpath
The directory that will hold teh CA and CRL files Defaults to '/etc/haproxy/certs.d'
puppet_ca_file_name
Data type: String[1]
The name to use for the CA file Defaults to 'puppet_ca.pem'
puppet_crl_file_name
Data type: String[1]
The name to use for the CRL Defaults to 'puppet-crl.pem'
Defined types
haproxy_consul::resolver
Generates a HAProxy resolver backed by Consul by querying the specified
Consul server and getting all the nodes for the service named consul. The
resolver will use port 8600 for DNS queries by default but that can be
overridden by crating a key named consul-dns/port and setting its value
to the desired port (i.e. 53).
- See also
- haproxy::resolver
- for more details on HAProxy-related parameters
- haproxy::resolver
Examples
haproxy_consul::resolver { 'https://consul.example.com:8500': }
Parameters
The following parameters are available in the haproxy_consul::resolver defined type:
consul_server
Data type: Stdlib::Httpurl
The full url to your Consul server including protocol and port
Default value: $title
resolver_name
Data type: String[1]
The name of the resolver that will be referenced in the balancemember's options Defaults to 'consul'
Default value: 'consul'
resolve_retries
Data type: Integer
Defines the number of queries to send to resolve a server name before giving up. Defaults to 3.
Default value: 3
timeout
Data type: Hash
Defines timeouts related to name resolution in the listening serivce's configuration block. Defaults to { 'retry' => '2s' }
Default value: { 'retry' => '2s' }
hold
Data type: Optional[Hash]
Defines during which the last name resolution should be kept based on last valid resolution status. Defaults to undef
Default value: undef
haproxy_consul::server_template
Creating both the haproxy::listen and haproxy::balancermember for each
service you wish to use with HAProxy's 'server-template' requires a lot of
redundant code and, if you are using multi-resource declarations, can put the
two components way away from each other in your manifest. This simplifies the
process by collecting all the information that differes from service to
service and then creates the required haproxy resources.
Examples
include haproxy_consul::puppet_ca_files
$_consul_domain = 'consul.example.com'
$_haproxy_cert_dir = lookup('haproxy_consul::puppet_ca_files::haproxy_cert_dir')
$_puppet_ca_file = "${_haproxy_cert_dir}/${lookup('haproxy_consul::puppet_ca_files::puppet_ca_file_name')}"
$_puppet_crl_file = "${_haproxy_cert_dir}/${lookup('haproxy_consul::puppet_ca_files::puppet_crl_file_name')}"
haproxy_consul::server_template {
default:
consul_domain => $_consul_domain,
amount => '1',
require => Class['Haproxy_consul::Puppet_ca_files'],
;
'pe-console-https':
ports => '443',
listen_options => {
'balance' => 'roundrobin',
'option' => [
'ssl-hello-chk',
],
},
balancermember_options => [
'resolvers consul',
'resolve-prefer ipv4',
'check',
],
;
'pe-compiler-puppet-agent':
ports => '8140',
listen_options => {
'option httpchk' => 'get /status/v1/simple/master',
},
balancermember_options => [
'resolvers consul',
'resolve-prefer ipv4',
'check check-ssl',
'port 8140',
'verify required',
"ca-file ${_puppet_ca_file}",
"crl-file ${_puppet_crl_file}",
],
amount => '1-8',
;
}
Parameters
The following parameters are available in the haproxy_consul::server_template defined type:
ports
Data type: Variant[String[1], Array[String[1]]]
The port or ports the service listens on Accepts either a single comma-separated string or an array of strings which may be ports or hyphenated port ranges.
amount
Data type: String[1]
Initializes servers with 1 up to as server name suffixes. A range of numbers <num_low>-<num_high> may also be used to use <num_low> up to <num_high> as server name suffixes.
consul_domain
Data type: Stdlib::Fqdn
The fqdn used by services registered in consul
ipaddress
Data type: String[1]
The address to lsten on. Defaults to '*'
Default value: '*'
listen_options
Data type: Optional[Hash]
An optional hash of options for the listening service
Default value: undef
balancermember_options
Data type: Optional[Array[String[1]]]
An optional hash of options for the backend balancemembers
Default value: undef
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
2.0.0 (2021-09-18)
Changed
1.0.1 (2019-04-12)
Fixed
1.0.0 (2019-04-12)
Added
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- ploperations/consul_data (>= 0.1.0 < 2.0.0)
- puppetlabs/firewall (>= 1.7.0 < 2.0.0)
- puppetlabs/haproxy (>= 3.0.1 < 4.0.0)
- puppetlabs/stdlib (>= 4.25.0 < 6.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.