Version information
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
- Puppet >= 7.0.0 < 9.0.0
- ,
Tasks:
- add_custom_facts
- deactivate_nodes
- get_certificate_request
- revoke_certificates
- set_puppet_config
- sign_certificate_requests
Plans:
- commission
- decommission
Start using this module
Add this module to your Puppetfile:
mod 'opuscodium-commission', '1.1.0'
Learn more about managing modules with a PuppetfileDocumentation
puppet-commission
Commission / decommission Puppet nodes easily.
This module provides Bolt plans to commission / decommission Puppet nodes.
Getting started
Use this module to setup commissioning / decommissioning plans tailored to your site. We ship two sample plans with the module: commission::commission
and commission::decommission
. These plans are site-agnostic and not too much opiniated to be used in any infrastructure. Use them to give a try to the module and as a template for your site-specific plans.
To setup site-specific plan for your ACME organization, start with your Bolt project:
romain@marvin % mkdir acme
romain@marvin % cd acme
romain@marvin ~/acme % bolt project init --modules opuscodium-commission acme
Installing project modules
→ Resolving module dependencies, this might take a moment
→ Writing Puppetfile at ~/acme/Puppetfile
→ Syncing modules from ~/acme/Puppetfile to ~/acme/.modules
→ Generating type references
Successfully synced modules from ~/acme/Puppetfile to ~/acme/.modules
romain@marvin ~/acme % mkdir -p plans
romain@marvin ~/acme % sed -e 's/commission::commission/acme::commission/' -e '/@api private/,+1d' < .modules/commission/plans/commission.pp > plans/commission.pp
romain@marvin ~/acme % bolt plan show
Plans
acme::commission Commission a node and connect it to the Puppet infrastructure
[...]
Edit the plans/commission.pp
plan to fit your site policies, requirements, etc. Feel free to hardcode the puppet server name, fetch data from PuppetDB, prompt the user for inputs, and so on… When done, setup a decommissioning plan in a similar fashion.
Commissioning nodes
romain@marvin ~/acme % bolt plan run acme::commission -t node1.example.com,node2.example.com
Decommissioning nodes
romain@marvin ~/acme % bolt plan run acme::decommission -t node1.example.com,node2.example.com
Reference
Table of Contents
Tasks
add_custom_facts
: Add custom factsdeactivate_nodes
: Deactivate nodes in PuppetDBget_certificate_request
: Get the fingerprint of the certificate request of a Puppet noderevoke_certificates
: Revoke certificates on the Puppet Serverset_puppet_config
: Set Puppet configurationsign_certificate_requests
: Sign certificate requests on the Puppet Server
Plans
Private Plans
commission::commission
: Commission nodes and connect them to the Puppet infrastructurecommission::decommission
: Decommission nodes and disconnect them from the Puppet infrastructure
Tasks
add_custom_facts
Add custom facts
Supports noop? false
Parameters
custom_facts_dir
Data type: Optional[Stdlib::AbsolutePath]
The directory of custom facts
facts
Data type: Hash[String[1],Any]
The facts to set
deactivate_nodes
Deactivate nodes in PuppetDB
Supports noop? false
Parameters
nodes
Data type: Array[String[1]]
The nodes to deactivate
get_certificate_request
Get the fingerprint of the certificate request of a Puppet node
Supports noop? false
revoke_certificates
Revoke certificates on the Puppet Server
Supports noop? false
Parameters
certificates
Data type: Array[String[1]]
The certificates to revoke
set_puppet_config
Set Puppet configuration
Supports noop? false
Parameters
settings
Data type: Hash[String[1],Any]
The settings to set
sign_certificate_requests
Sign certificate requests on the Puppet Server
Supports noop? false
Parameters
certificate_requests
Data type: Hash[String[1], Struct[{digest => String[1], fingerprint => String[1]}]]
Attributes of the certificate requests to sign
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
get_certificate_request
Get the fingerprint of the certificate request of a Puppet node
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
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.
v1.1.0 (2024-09-16)
Implemented enhancements:
Fixed bugs:
v1.0.0 (2023-11-24)
Breaking changes:
Implemented enhancements:
- Add support for Puppet 8 #22 (smortex)
- Improve error reporting #20 (smortex)
- Hide template plans by default #19 (smortex)
- Switch to tasks for decommissioning nodes #18 (smortex)
- Refactor the certificates management tasks #16 (smortex)
- Set puppet settings from a task instead of a script #15 (smortex)
- Improve the add_custom_facts task #14 (smortex)
- Make commission plan site specific #13 (smortex)
- Add support for Debian 11 #12 (smortex)
- Document plans parameters #10 (smortex)
- Add task for adding facts: add_custom_facts #5 (smortex)
- Add a commissionned_at fact #4 (smortex)
- Ensure lspci(1) is installed before running Puppet #2 (smortex)
Fixed bugs:
- Fix arguments parameter for run_script #3 (smortex)
- Strip username and port from provisionning targets #1 (smortex)
Merged pull requests:
- Ensure Puppet AIO path #17 (smortex)
- Update README badges #11 (smortex)
- Bump minimal Puppet version to 6.0.0 #9 (smortex)
- No need to load puppet facts #7 (smortex)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/ruby_task_helper (>= 0.6.0 < 1.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.