puppet_health_check
Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 6.0.0
- , , , , , , , , , ,
Tasks:
- agent_health
- fix_cached_catalog
- fix_lockfile
- fix_noop
- fix_runinterval
Plans:
- fix_nodes
Start using this module
Add this module to your Puppetfile:
mod 'albatrossflavour-puppet_health_check', '0.7.0'
Learn more about managing modules with a PuppetfileDocumentation
puppet_health_check
Table of Contents
- Description
- Setup - The basics of getting started with puppet_health_check
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
A set of tasks (and plan) to carry out health checks on puppet agents. Includes things such as :
- Validating the puppetmaster/compile masters are reachable from the agent
- The puppet agent is enabled and running
- The run interval is set to the desired value
- The last run was within the run interval
- If the catalog failed to compile
- If any errors were encountered on the last puppet run
Setup
Providing you can run tasks, you should be ok. The tasks and plan have been tested on Linux (centos and debian) and various Windows versions. It SHOULD work on anything with a puppet agent capable of running tasks.
Beginning with puppet_health_check
puppet task show puppet_health_check::agent_health
should get you going, everything is driven through tasks and plans which can be accessed from the command line or the PE console. When you run the task, you'll see output like:
# puppet task run puppet_health_check::agent_health -q 'inventory[certname] {}'
Starting job ...
Note: The task will run only on permitted nodes.
New job ID: 487
Nodes: 4
Started on puppetmaster.example.com ...
Started on client01.example.com ...
Started on win-3ebipmjenlq.example.com ...
Started on client02.example.com ...
Finished on node client02.example.com
date : 2018-09-04T14:24:55+10:00
state : clean
certname : client02.example.com
Finished on node puppetmaster.example.com
date : 2018-09-04T14:24:55+10:00
state : clean
certname : puppetmaster.example.com
Finished on node client01.example.com
date : 2018-09-04T14:24:56+10:00
state : clean
certname : client01.example.com
Failed on win-3ebipmjenlq.example.com
Error: Task finished with exit-code 1
date : 2018-09-04T14:26:28+10:00
state : issues found
service : Puppet service not configured to run
certname : win-3ebipmjenlq.example.com
Job completed. 4/4 nodes succeeded.
Duration: 5 sec
Usage
All driven through tasks, either from the CLI, the console or via the API
The health check task will check the following things :
- Is the agent running?
- Is the agent enabled?
- Is agent noop set?
- Is the agent lockfile present?
- Is the run interval set correctly?
- Is a signed certificate present?
- Was the last agent run within the right timeframe?
- Were there failures in the last run?
- Did the catalog compilation fail?
- Can the agent reach a (compile)master on the right port?
A bolt plan
exists which automates the end to end check and resolution of (most) issue.
The plan executes the health check, picks up failures which it can deal with (see below), tries to resolve them, re-checks the failed nodes and then reports on the results.
- Start the agent
- Enable the agent
- Reset noop mode
- Reset run interval
- Remove lockfile
- Trigger an agent run
Example
# bolt plan --modulepath '/etc/puppetlabs/code/environments/production/modules/' run puppet_health_check::fix_nodes --query='inventory[certname] {}' --transport pcp --format json
Starting: plan puppet_health_check::fix_nodes
client01.example.com,0,heath check passed
puppetmaster.example.com,0,heath check passed
client02.example.com,3,runinterval fixed
client02.example.com,4,puppet agent failed
Finished: plan puppet_health_check::fix_nodes in 6.14 sec
The exit codes from the plan are :
- 0 : Clean
- 1 : Health check couldn't run
- 3 : Issue found but fixed
- 4 : Issue found but automated fix failed
- 100 : Issues remaining at the end of the check
Limitations
I'm sure there are many, but not found anything obvious yet
Development
Fork, develop, submit a PR
Reference
Table of Contents
Tasks
agent_health
: Check the health of a puppet agentfix_noop
: Set the noop value of a nodefix_runinterval
: Set the runinterval value of a node
Plans
puppet_health_check::fix_nodes
: Plan to carry out automated fixes found by the health_check task
Tasks
agent_health
Check the health of a puppet agent
Supports noop? true
Parameters
target_runinterval
Data type: Optional[Integer]
What should the agent run interval be set to? (Defaults to 1800 seconds)
target_noop_state
Data type: Optional[Boolean]
What should the agent noop state be set to? (Defaults to false)
target_service_enabled
Data type: Optional[Boolean]
Should the puppet service be enabled? (Defaults to true)
target_service_running
Data type: Optional[Variant[Boolean,Enum['running', 'stopped']]]
Should the puppet service be running? (Defaults to 'running')
fix_noop
Set the noop value of a node
Supports noop? false
Parameters
target_state
Data type: Optional[Boolean]
What should the agent noop value be set to? (Defaults to false)
fix_runinterval
Set the runinterval value of a node
Supports noop? false
Parameters
target_state
Data type: Optional[Integer]
What should the runinterval value be set to? (Defaults to 1800)
Plans
puppet_health_check::fix_nodes
Plan to carry out automated fixes found by the health_check task
Parameters
The following parameters are available in the puppet_health_check::fix_nodes
plan.
nodes
Data type: TargetSpec
target_noop_state
Data type: Boolean
Default value: false
target_runinterval
Data type: Integer
Default value: 1800
target_service_enabled
Data type: Boolean
Default value: true
target_service_running
Data type: Boolean
Default value: true
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
fix_lockfile
Remove the agent lock file
What are plans?
Modules can contain plans that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Changelog
0.7.0 (2020-08-10)
Implemented enhancements:
- Exit with error on failure
0.6.0 (2020-08-05)
Implemented enhancements:
- Support compiler network port checks
0.5.2 (2020-07-23)
Fixed bugs:
- Module lacks 2019 support in both metadata and functionality #12
0.5.1 (2020-07-23)
0.5.0 (2019-11-22)
Implemented enhancements:
- Switch certificate validation over to
puppet ssl verify
#9
Merged pull requests:
- V0.5.0 release #11 (albatrossflavour)
0.4.0 (2019-07-08)
Merged pull requests:
- Release V0.4.0 #8 (albatrossflavour)
- Litmus testing for linux complete #6 (albatrossflavour)
0.3.0 (2019-02-17)
Merged pull requests:
- Pre-V0.3.0 release #5 (albatrossflavour)
- Release of V0.3.0 #4 (albatrossflavour)
- Merge to master #3 (albatrossflavour)
0.2.0 (2019-01-11)
Merged pull requests:
- Feature/plans #2 (albatrossflavour)
- Feature/improvements #1 (albatrossflavour)
* This Changelog was automatically generated by github_changelog_generator
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.