Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
- Puppet >= 5.5.8 < 7.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-smokeping', '5.1.1'
Learn more about managing modules with a PuppetfileDocumentation
SmokePing Puppet module
Puppet module to completely manage a SmokePing installation. Includes managing of Master/Slave installation and the menu hierarchy.
Some background information can be found here: Puppet module to manage SmokePing
Features
- Master/Slave/Standalone SmokePing configuration possible
- Menu hierarchy implemented
- Define Probes and Alert patterns
- Config files managed with templates
- Uses exported resources to configure Slaves on the Master (tag: smokeping-slave)
- Automatically generates a shared secret for Master/Slave configuration (tag: smokeping-slave-secret)
Supported Platforms
Fully supported:
- Ubuntu (Tested on 12.04, 14.04)
Standalone Only (no master/slave support yet):
- Fedora 22+
- CentOS 7+ (Note: requires third party repository to provide smokeping package).
Dependencies
Example
Standalone SmokePing instance
# install a standalone instance on a server with default values (see init.pp for
# parameter documentation
class { '::smokeping':
mode => 'standalone',
}
Master SmokePing instance
# install a master instance on a server with default values (see init.pp for
# parameter documentation. You must have a slave, or this will not work!
class { '::smokeping':
mode => 'master',
}
Slave SmokePing instance
class { '::smokeping':
mode => 'slave',
slave_name => $::hostname,
master_url => 'http://myserver.tld/smokeping/smokeping.cgi',
slave_location => 'zurich',
}
This configures the server as slaves and adds the slave definition automatically to the master using exported resources.
Probes
$probes = [
{ name => 'FPing', binary => '/usr/bin/fping' },
{ name => 'FPing6', binary => '/usr/bin/fping6' },
]
Class['::smokeping'] {
probes => $probes
}
Alerts
$alerts = [
{
name => 'bigloss',
alert_type => 'loss',
pattern => '==0%,==0%,==0%,==0%,>0%,>0%,>0%',
comment => 'suddenly there is packet loss',
},
{
name => 'startloss',
alert_type => 'loss',
pattern => '==S,>0%,>0%,>0%',
comment => 'loss at startup',
},
{
name => 'noloss',
alert_type => 'loss',
pattern => '>0%,>0%,>0%,==0%,==0%,==0%,==0%',
edgetrigger => true,
comment => 'there was loss and now its reachable again',
},
]
Class['::smokeping'] {
alerts => $alerts,
}
Targets
# Top Level
smokeping::target { 'World':
menu => 'World',
pagetitle => 'Connection to the World',
alerts => [ 'bigloss', 'noloss' ],
}
smokeping::target { 'GoogleCH':
hierarchy_parent => 'World',
hierarchy_level => 2,
menu => 'google.ch',
pagetitle => 'Google',
}
smokeping::target { 'GoogleCHIPv4':
hierarchy_parent => 'GoogleCH',
hierarchy_level => 3,
menu => 'google.ch IPv4',
host => 'google.ch',
slaves => ['slave1'],
}
smokeping::target { 'GoogleCHIPv6':
hierarchy_parent => 'GoogleCH',
hierarchy_level => 3,
menu => 'google.ch IPv6',
host => 'google.ch',
probe => 'FPing6',
slaves => ['slave1'],
}
smokeping::target { 'GoogleCHCurl':
hierarchy_parent => 'GoogleCH',
hierarchy_level => 3,
menu => 'google.ch Curl',
host => 'google.ch',
probe => 'Curl',
options => {
urlformat => 'http://%host%/',
}
}
License / Author
The module is written by
- Tobias Brunner tobias@tobru.ch
Licensed under Apache License, Version 2.0, Copyright 2015 by Tobias Brunner
Contibutors
See: Github Contributors
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v5.1.1 (2020-09-25)
Closed issues:
- Support latest puppetlabs-firewall #128
Merged pull requests:
- Update dependencies to support latest puppetlabs-firewall #129 (andybotting)
v5.1.0 (2020-09-24)
Implemented enhancements:
- add support for Puppet 5 #82
Fixed bugs:
- Allow puppetlabs/concat 6.x, puppetlabs/stdlib 6.x #110 (dhoppe)
- Fix selinux::module parameter #109 (sapakt)
Closed issues:
- Support latest puppetlabs-apache #125
Merged pull requests:
- Support puppetlabs-apache 5.x #126 (andybotting)
- modulesync 3.0.0 & puppet-lint updates #118 (bastelfreak)
- update repo links to https #116 (bastelfreak)
- Allow puppet-selinux 2.x and 3.x #111 (ekohl)
v5.0.0 (2019-05-07)
Breaking changes:
- modulesync 2.7.0 and drop puppet 4 #106 (bastelfreak)
Merged pull requests:
- Allow puppetlabs/apache 4.x #107 (dhoppe)
- modulesync 2.2.0 and allow puppet 6.x #103 (bastelfreak)
v4.0.0 (2018-09-17)
Breaking changes:
- Fix smokeping::target type #99 (alexjfisher)
Implemented enhancements:
- Update module dependencies #100 (alexjfisher)
Closed issues:
- Variables 'remark' and 'hierarchy_parent' should have defaults matching validation as strings. #74
Merged pull requests:
- Add EL7 operating systems to metadata.json #101 (alexjfisher)
- allow puppetlabs/stdlib 5.x #96 (bastelfreak)
v3.1.1 (2018-06-17)
Fixed bugs:
Merged pull requests:
- Remove docker nodesets #90 (bastelfreak)
- drop EOL OSs; fix puppet version range #89 (bastelfreak)
v3.1.0 (2018-03-30)
Fixed bugs:
Merged pull requests:
- fix project_page link in metadata.json #85 (bastelfreak)
- bump puppet to latest supported version 4.10.0 #84 (bastelfreak)
v3.0.0 (2017-11-11)
Merged pull requests:
- replace validate_* with datatypes in target #70 (bastelfreak)
- Add basic unit testing #69 (bastelfreak)
- purge trailing whitespace in README.md #68 (bastelfreak)
v2.0.0 (2017-02-11)
Closed issues:
- Standalone mode complains about missing Slaves file. #44
- Use puppetlabs-concat instead of ripienaar-concat? #41
- /etc/smokeping/config.d/Slaves is declared twice on a master #38
- Slave config? #34
- /etc/smokeping/config seems not to be managed by puppet-smokeping module #25
Merged pull requests:
- Bump minimum version dependencies (for Puppet 4) #57 (juniorsysadmin)
- Bump puppet minimum version_requirement to 3.8.7 #56 (juniorsysadmin)
- Fix puppet syntax in README.md #55 (AlessandroLorenzi)
- Lint fixes and metadata.json #53 (alexjfisher)
- Concat resources need to depend on target dir #49 (claytono)
- Add support to manage an SELinux policy #47 (djjudas21)
- Add edgetrigger option to smokeping alerts. #46 (gfokkema)
- Manage Apache #45 (djjudas21)
- Fix param name #43 (djjudas21)
- Only include /etc/smokeping/conf.d/Slaves when mode is master #40 (davewongillies)
v1.7.2 (2016-02-18)
Merged pull requests:
v1.7.1 (2015-12-11)
Merged pull requests:
- Include params needed #37 (AlexRRR)
- perldoc namespace incorrect #36 (AlexRRR)
- Allow to specify targets through hiera #35 (vincentbernat)
- Initial EL (RHEL, CentOS, Fedora, Scientific Linux, Amazon Linux, etc) support #32 (jethrocarr)
- Small Improvements #30 (jethrocarr)
- Added minimum framework for tests to enable syntax validation. #29 (jethrocarr)
- Don't invent email addresses, use example.com/org/net or localhost #28 (jethrocarr)
- Fixed error while using slave_display_name (was ignored) #27 (fetzerms)
- Fixed error on slave color not beeing automatically generated. #26 (fetzerms)
- Rename type parameter for future parser compat #24 (claytono)
v1.7.0 (2015-02-19)
Closed issues:
- Tags would be really very handy. #15
Merged pull requests:
- fix(hostname): remove hostname from default #23 (alkivi-sas)
- fix(templates): naming variables for templates #22 (alkivi-sas)
- Allow leaving out of alerts parameter (empty array instead of false by default) #21 (legooolas)
v1.6.0 (2014-10-21)
Fixed bugs:
- Master without slaves #4
Closed issues:
Merged pull requests:
- Require smokeping installed before creating dirs #19 (claytono)
- Allow arbitrary probe config values #16 (claytono)
- Allow setting the step for FPing Probes #13 (darkyat)
- Use validate_re to detect whitespace in title #11 (hakamadare)
- added options param to smokeping::target #9 (hakamadare)
- indentation cleanup #8 (rendhalver)
- Add support for empty "alerts =" lines in targets. #7 (cjsoftuk)
- Add standalone option, fix webserver user, some alinging #5 (darktim)
- Fix slave_color format for colors \< 100000 #2 (x-way)
- make nomasterpoll configurable in smokeping::target #1 (x-way)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/apache (>= 1.6.0 < 6.0.0)
- puppetlabs/concat (>= 4.1.0 < 7.0.0)
- puppetlabs/firewall (>= 1.7.0 < 3.0.0)
- puppetlabs/stdlib (>= 4.25.0 < 7.0.0)
- puppet/selinux (>= 1.0.0 < 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