Version information
released Dec 7th 2023
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 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, 2019.0.x
- Puppet >= 6.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'cmdntrf-consul_template', '2.3.8'
Learn more about managing modules with a PuppetfileDocumentation
cmdntrf/consul_template — version 2.3.8 Dec 7th 2023
puppet-consul_template
Fork of claranet/puppet-consul_template that is compatible with Puppet 6.
Table of Contents
- Overview - What is the puppet-consul_template module?
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module:
- Installs the consul-template binary (via url or package)
- Optionally installs a user to run it under
- Installs a configuration file to
/etc/consul-template/config.json
- Manages the consul-template service via upstart, sysv, or systemd
Usage
The simplest way to use this module is:
include ::consul_template
Consul-template Options
consul-template options can be passed via hiera:
consul_template::config_defaults:
consul:
retry:
attemtps: 12
backoff: 250ms
token: <consul token>
reload_signal: SIGHUP
kill_signal: SIGINT
deduplicate:
enabled: true
log_level: info
max_stale: 10m
syslog:
enabled: true
Or via class parameters:
class { 'consul_template':
service_enable => false
config_hash => {
log_level => 'debug',
wait => '5s:30s',
max_stale => '1s'
}
}
Watch files
To declare a file that you wish to populate from Consul key-values, use the
watch
define. This requires a source .ctmpl
file and the file on-disk
that you want to update.
consul_template::watch { 'common':
template => 'data/common.json.ctmpl.erb',
template_vars => {
'var1' => 'foo',
'var2' => 'bar',
},
config_hash => {
perms => '0644',
destination => '/tmp/common.json',
command => 'true',
},
}
Full Parameter List
Parameter | Default | Description |
---|---|---|
purge_config_dir |
true |
If enabled, removes config files no longer managed by Puppet. |
config_mode |
0660 |
Mode set on config files and directories. |
bin_dir |
/usr/local/bin |
Path to the consul-template binaries |
arch |
Read from facter | System architecture to use (amd64, x86_64, i386) |
version |
0.22.0 |
Version of consul-template to install via download |
install_method |
url |
When set to 'url', consul-template is downloaded and installed from source. If set to 'package', its installed using the system package manager. |
os |
Read from facter | |
download_url |
undef |
URL to download consul-template from (when install_method is set to 'url') |
download_url_base |
https://releases.hashicorp.com/consul-template |
Base URL to download consul-template from (when install_method is set to 'url') |
download_extension |
zip |
File extension of consul-template binary to be downloaded (when install_method is set to 'url') |
package_name |
consul-template |
Name of package to install |
package_ensure |
latest |
Version of package to install |
config_dir |
/etc/consul-template |
Path to store the consul-template configuration |
extra_options |
'' |
Extra options to be passed to the consul-template agent. See https://github.com/hashicorp/consul-template#options |
service_enable |
true |
|
service_ensure |
running |
|
user |
root |
This used to be a default of consul-template and this caused much out-of-box pain for people. |
group |
root |
|
manage_user |
false |
Module handles creating the user. |
manage_group |
false |
Module handles creating the group. |
init_style |
See params.pp |
Init style to use for consul-template service. |
log_level |
info |
Logging level to use for consul-template service. Can be 'debug', 'warn', 'err', 'info' |
config_hash |
{} |
Consul-template configuration options. See https://github.com/hashicorp/consul-template#options |
config_defaults |
{} |
Consul-template configuration option defaults. |
pretty_config |
false |
Generates a human readable JSON config file. Defaults to false . |
pretty_config_indent |
4 |
Toggle indentation for human readable JSON file. |
Limitations
Depends on the JSON gem, or a modern ruby.
Development
- Copyright (C) 2017 Claranet
- Distributed under the terms of the Apache License v2.0 - see LICENSE file for details.
- To contribute, see the contributing guide, then open an issue or fork and open a Pull Request
Change Log
Release notes for the cmd-ntrf/puppet-consul_template module.
2.3.3 - 2021-10-13
- Fix changelog
2.3.2 - 2021-10-13
- Add comptability with Rocky and AlmaLinux
2.3.1 - 2021-06-14
- Replace dependency on staging by archive in metadata.json
2.3.0 - 2019-09-24
- Update to consul-template 0.22.0
- Update config.json configuration and corresponding documentation
2.2.0 - 2019-07-29
- Reinstate dependency on KyleAnderson/consul to fix issue with
sorted_generate
function - Merge branch 'feature/archive' of surcouf to replace staging by archive
2.1.1 - 2018-08-30
PDK Support
- This module is now compatible with the Puppet Development Kit - this can be verified by running
pdk validate
- Testing has also been extended to the
consul_template_sorted_json
function, originally forked fromsolarkennedy-consul
2.1.0 - 2018-05-29
Ubuntu Support
- Support for Ubuntu 18.04 and newer has been added by defaulting to
systemd
inparams.pp
- #116
Dependency Changes
- The
consul_sorted_json
function has been forked fromsolarkennedy-consul
at commit 993dd2b to remove upstream dependency issues and renamed toconsul_template_sorted_json
.
2.0.0 - 2017-12-19
Breaking/Backwards-Incompatible Changes - Puppet 4 Syntax
- Parameters are validated against Puppet 4 data types
- Stdlib version requirements have been raised
- Restructure class inclusion by replacing anchor pattern with 'contain' and class ordering
- Rename
$::foo
to$foo
- Switch to structured facts
- Move from
$foo_real
to$_foo
pattern - Thanks to Will Yardley for raising #108
1.0.1 - 2017-12-19
Bug Fix and Deprecation
- This is the last version of the module to be released with compatibility for Puppet 3
- Backported fix for #115
1.0.0 - 2017-12-07
Breaking/Backwards-Incompatible Changes
- Use
config_hash
for most config options deprecating many parameters, based on changes made in github/consul_template fork (#110 / #111). Thanks to ross and GitHub for allowing this to be adopted back upstream. - Drop support for very old OSes like RHEL/CentOS 5, etc.
- Now depends on
KyleAnderson/consul
module forconsul_sorted_json
function. - Deprecated the following parameters:
consul_host
consul_port
consul_token
consul_retry
consul_retry_attempts
consul_retry_backoff
consul_wait
consul_max_stale
deduplicate
deduplicate_prefix
log_level
vault_enabled
vault_address
vault_token
vault_ssl
vault_ssl_verify
vault_ssl_cert
vault_ssl_ca_cert
consul_reload_signal
consul_kill_signal
consul_ssl_enabled
consul_ssl_verify
consul_ssl_cert
consul_ssl_ca_cert
- Added parameters:
pretty_config
pretty_config_indent
config_hash
config_defaults
0.2.9 - 2016-11-01
- Feature Enhancement: Change consul-tempalte systemd restart option
0.2.8 - 2016-05-11
- Bugfix: Revert: Do not create the user group by default. Run consul-template as root/root instead
0.2.7 - 2016-05-11
- Pulled
0.2.6 - 2016-05-11
- Bugfix: Create the user group by default, else we can't chown the install directory #70
0.2.5 - 2016-03-31
- Feature: Support logrotate through
logrotate_on
#50 - Feature: Support watches definition in Hiera #59
- Bugfix: Don't use root if we launch through Upstart or Systemd #51 #60
- Bugfix: Allow both or neither of
template
andsource
to be set #52 - Bugfix: Anchors to improve dependency resolution #62 #63
- Bugfix: All
consul_template
releases are now zipfiles - removestrip
arg #65
0.2.4 - 2015-12-17
- Feature: Use releases.hashicorp.com download URL #42
- Feature: Better UNIX permissions on config/template files #43
- Feature: Specify existing source file location for watches #45
- Bugfix: config param name should be max_stale rather than max-stale #46
0.2.3 - 2015-10-22
- Bugfix: downloading older versions of Consul Template works again #39
0.2.2 - 2015-10-19
- Support upgrades of Consul Template on the same machine #37
0.2.1 - 2015-10-19
0.2.0 - 2015-07-03
Dependencies
- puppetlabs/stdlib (>= 4.13.1)
- puppetlabs/concat (>= 2.2.0)
- puppet/archive (>= 4.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.