bootstrap

Tasks that bootstrap/install Puppet Enterprise agents on Linux and Windows

45,911 downloads

262 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 3.0.0 (latest)
  • 2.1.0
  • 2.0.0
  • 1.0.0
  • 0.5.0
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.1
released Jan 29th 2025
This version is compatible with:
  • Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 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:
  • bootstrap

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-bootstrap', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-bootstrap
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-bootstrap --version 3.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/bootstrap — version 3.0.0 Jan 29th 2025

Reference

Table of Contents

Tasks

  • init: Bootstrap a node with puppet-agent
  • linux: Bootstrap a node with puppet-agent for Linux
  • windows: 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

set_noop

Data type: Optional[Boolean]

The noop setting in the [agent] section of puppet.conf

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

puppet_conf_settings

Data type: Optional[Array[Pattern[/\w+:\w+=.*/]]]

Puppet conf settings. See https://www.puppet.com/docs/pe/2021.7/installing_nix_and_windows_agents_using_an_install_script.html#customize-install-script for usage instructions

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

set_noop

Data type: Optional[Boolean]

The noop setting in the [agent] section of puppet.conf

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

puppet_conf_settings

Data type: Optional[Array[Pattern[/\w+:\w+=.*/]]]

Puppet conf settings. See https://www.puppet.com/docs/pe/2021.7/installing_nix_and_windows_agents_using_an_install_script.html#customize-install-script for usage instructions

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

set_noop

Data type: Optional[Boolean]

The noop setting in the [agent] section of puppet.conf

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

puppet_conf_settings

Data type: Optional[Array[Pattern[/\w+:\w+=.*/]]]

Puppet conf settings. See https://www.puppet.com/docs/pe/2021.7/installing_nix_and_windows_agents_using_an_install_script.html#customize-install-script for usage instructions