bootstrap
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.10 < 7.0.0
- Debian,CentOS,OracleLinux,RedHat,Ubuntu,windows
Tasks:
- bootstrap
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-bootstrap', '2.1.0'Learn more about managing modules with a PuppetfileDocumentation
bootstrap
Table of Contents
- Description
- Requirements
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the task is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Getting help - Some Helpful commands
Description
This module provides the bootstrap task. This allows you to install Puppet agents on un-puppeted hosts via the ssh or winrm transports.
Requirements
This module requires both the bolt gem on the machine from which you are running bolt commands (the controller node), and a Puppet Enterprise 2017.3 or later master hosting agent repositories.
Linux machines receiving task requests must have bash for now. Windows machines must have PowerShell. (See Limitations for more info.)
Usage
To run the bootstrap task, use the bolt command, specifying the PE master from which the Puppet agent package should be installed and to which the agent should submit its certificate for signing.
Example: Basic usage
On the command line:
- For Linux, run
bolt task run bootstrap::linux master=<master's fqdn> --nodes x,y,z --modulepath /path/to/modules - For Windows, run
bolt task run bootstrap::windows master=<master's fqdn> --nodes x,y,z --modulepath /path/to/modulesFor all advanced examples below, simply replacebootstrap::linuxbybootstrap::windowsto perform the action on Windows.
Example: Verify the master's CA on initial connection
Optionally to validate the connection during the bootstrap process, specify the puppet master's CA cert by adding the cacert_content option:
bolt task run bootstrap::linux master=<master's fqdn> cacert_content="$(cat /etc/puppetlabs/puppet/ssl/certs/ca.pem)" --nodes x,y,z --modulepath /path/to/modules
Example: Specify a custom certname
Optionally to install the Puppet agent with a certname other than the fqdn of the target node, specify the custom certname:
bolt task run bootstrap::linux master=<master's fqdn> certname=<custom certname> --nodes x,y,z --modulepath /path/to/modules
Example: Specify the environment
Optionally to install the puppet-agent with a specific environment other than the default environment production, specify the custom environment:
bolt task run bootstrap::linux master=<master's fqdn> environment=<custom environment> --nodes x,y,z --modulepath /path/to/modules
Example: Specify custom dns alt names
Optionally to install the Puppet agent with custom dns alt names, specify the custom dns alt names:
bolt task run bootstrap::linux master=<master's fqdn> dns_alt_names=<comma-separated list of alt names for the node> --nodes x,y,z --modulepath /path/to/modules
(see Compile master installation documentation for more info).
You can also run tasks in the PE console. See PE task documentation for complete information.
Example: Specify a custom_attribute
Optionally to install the Puppet agent and adding a setting to puppet.conf and including it in the custom_attributes section of csr_attributes.yaml: bolt task run bootstrap master=<master's fqdn> custom_attribute=key=value --nodes x,y,z --modulepath /path/to/modules
Example: Specify a extension_request
Optionally to install the Puppet agent and adding a setting to puppet.conf and including it in the extension_requests section of csr_attributes.yaml: bolt task run bootstrap master=<master's fqdn> extension_request=key=value --nodes x,y,z --modulepath /path/to/modules
Reference
For detailed reference information, see the REFERENCE.md
Limitations
The bootstrap task currently installs the agent via the Puppet Enterprise package management tools, and FOSS repository support will be added later. See the Puppet Enterprise documentation for more information.
For an extensive list of supported operating systems, see metadata.json
The bootstrap task is tested to work with Windows Management Framework >= v3.0+ and .NET >= v4.6 on the supported Windows operating systems.
Development
Acceptance tests for this module leverage puppet_litmus. To run the acceptance tests follow the instructions here. You can also find a tutorial and walkthrough of using Litmus and the PDK on YouTube.
If you run into an issue with this module, or if you would like to request a feature, please file a ticket. Every Monday the Puppet IA Content Team has office hours in the Puppet Community Slack, alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC).
If you have problems getting this module up and running, please contact Support.
If you submit a change to this module, be sure to regenerate the reference documentation as follows:
puppet strings generate --format markdown --out REFERENCE.md
Getting Help
To display help for the bootstrap task, run puppet task show bootstrap::linux or puppet task show bootstrap::windows
To show help for the task CLI, run puppet task run --help or bolt task run --help
Reference
Table of Contents
Tasks
init: Bootstrap a node with puppet-agentlinux: Bootstrap a node with puppet-agent for Linuxwindows: Bootstrap a node with puppet-agent for Windows
Tasks
init
Bootstrap a node with puppet-agent
Supports noop? false
Parameters
master
Data type: String
The fqdn of the master from which the puppet-agent should be bootstrapped
cacert_content
Data type: Optional[String]
The expected CA certificate content for the master
certname
Data type: Optional[String]
The certname with which the node should be bootstrapped
environment
Data type: Optional[String]
The environment in which the node should be bootstrapped
dns_alt_names
Data type: Optional[String]
The DNS alt names with which the agent certificate should be generated
custom_attribute
Data type: Optional[Array[Pattern[/\w+=\w+/]]]
This setting is added to puppet.conf and included in the custom_attributes section of csr_attributes.yaml
extension_request
Data type: Optional[Array[Pattern[/\w+=\w+/]]]
This setting is added to puppet.conf and included in the extension_requests section of csr_attributes.yaml
linux
Bootstrap a node with puppet-agent for Linux
Supports noop? false
Parameters
master
Data type: String
The fqdn of the master from which the puppet-agent should be bootstrapped
cacert_content
Data type: Optional[String]
The expected CA certificate content for the master
certname
Data type: Optional[String]
The certname with which the node should be bootstrapped
environment
Data type: Optional[String]
The environment in which the node should be bootstrapped
dns_alt_names
Data type: Optional[String]
The DNS alt names with which the agent certificate should be generated
custom_attribute
Data type: Optional[Array[Pattern[/\w+=\w+/]]]
This setting is added to puppet.conf and included in the custom_attributes section of csr_attributes.yaml
extension_request
Data type: Optional[Array[Pattern[/\w+=\w+/]]]
This setting is added to puppet.conf and included in the extension_requests section of csr_attributes.yaml
windows
Bootstrap a node with puppet-agent for Windows
Supports noop? false
Parameters
master
Data type: String
The fqdn of the master from which the puppet-agent should be bootstrapped
cacert_content
Data type: Optional[String]
The expected CA certificate content for the master
certname
Data type: Optional[String]
The certname with which the node should be bootstrapped
environment
Data type: Optional[String]
The environment in which the node should be bootstrapped
dns_alt_names
Data type: Optional[String]
The DNS alt names with which the agent certificate should be generated
custom_attribute
Data type: Optional[Array[Pattern[/\w+=\w+/]]]
This setting is added to puppet.conf and included in the custom_attributes section of csr_attributes.yaml
extension_request
Data type: Optional[Array[Pattern[/\w+=\w+/]]]
This setting is added to puppet.conf and included in the extension_requests section of csr_attributes.yaml
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
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.
v2.1.0 (2020-01-21)
Added
- (FM-8581) - Debian 10 added to travis and provision file refactored #124 (david22swan)
- pdksync - "MODULES-10242 Add ubuntu14 support back to the modules" #119 (sheenaajay)
- (FM-8686) - Addition of Support for CentOS 8 #117 (david22swan)
v2.0.0 (2019-11-11)
Changed
Fixed
- (MAINT) Ensure TLS is enabled first on Windows #106 (michaeltlombardi)
v1.0.0 (2019-07-25)
Changed
- pdksync - (MODULES-8444) - Raise lower Puppet bound #78 (david22swan)
Added
- (FM-8216) Switch testing to use Litmus #94 (eimlav)
- (FM-8150) Add Windows Server 2019 support #92 (eimlav)
- (FM-8038) Add RedHat 8 support #87 (eimlav)
- [FM-7942] Puppet Strings #86 (carabasdaniel)
Fixed
- (FM-8112) Ensure TLS 1.2 in Windows Task #90 (michaeltlombardi)
- (FM-7919) Ensure TLSv1.2 is used when temporarily disabling ssl #84 (steveax)
0.5.0 (2019-04-04)
Added
- (SEN-787) Make linux and windows private #73 (conormurraypuppet)
- (SEN-787) Add discovery extension metadata #72 (conormurraypuppet)
- (SEN-787) Add implementation metadata #71 (conormurraypuppet)
- (MODULES-6989) Multiple extension_requests/custom_attributes Linux task #61 (eimlav)
Fixed
- Ensure certnames are *always* lowercase #67 (dylanratcliffe)
- pdksync - (FM-7655) Fix rubygems-update for ruby \< 2.3 #56 (tphoney)
0.4.1 (2018-11-05)
Fixed
- (MODULES-8154) Correct environment argument #49 (MikaelSmith)
0.4.0 (2018-09-27)
Added
- pdksync - (FM-7392) - Puppet 6 Testing Changes #46 (pmcmaw)
- pdksync - (MODULES-6805) metadata.json shows support for puppet 6 #44 (tphoney)
- (MODULES-7511) Add Environment option for Windows #35 (MikaelSmith)
- (FM-7269) - Addition of support for ubuntu 1804 #34 (david22swan)
- (MODULES-7511) - Add ability to insert environment name during agent install #33 (raj-andy1)
- [FM-7063] Addition of Debian 9 support to Bootstrap #30 (david22swan)
Fixed
- (MODULES-7838) Windows task contains typo which causes failure. #45 (davejohnston)
0.3.0
Summary
This release removes the default eponymous task bootstrap and separates it into a bourne-shell bootstrap::linux task and a powershell bootstrap::windows task. It also includes a few new task parameters.
Changed
bootstrapinit task removed to be separated into windows & linux tasks.
Added
bootstrap::windowstask in powershellbootstrap::linuxtask in sh- Task parameter
custom_attributefor puppet.conf and csr_attributes.yaml - Task parameter
extension_requestfor puppet.conf and csr_attributes.yaml
Release 0.2.0
Summary
This makes the module PDK-compliant for easier maintenance. It also includes a roll up of maintenance changes.
Added
- PDK conversion MODULES-6468.
Fixed
- Update bolt usage typo in README MODULES-5945.
Release 0.1.1
Fix bash script.
Fixes
- Remove Function keyword from bash script.
Release 0.1.0
This is the initial release of the bootstrap task.
Features
- Bootstrap a node with puppet-agent, pointing it at a master.
- Check the CA certificate of the master.
- Set the DNS alt names for the agent.
- Set the certname with which the node should be bootstrapped.
* 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.