puppet_core_agent
Version information
This version is compatible with:
- Puppet Enterprise 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, 2021.7.x
- Puppet >= 7.24 < 9.0.0
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'klabsystems-puppet_core_agent', '0.3.0'Learn more about managing modules with a PuppetfileDocumentation
puppet_core_agent
Welcome to puppet_core_agent. This module is to streamline the Puppet Core adoption process whether you are coming from an existing OSP implementation or deploying from scratch.
Table of Contents
- Description
- Setup - The basics of getting started with puppet_core_agent
- Usage - Configuration options and additional functionality
Description
puppet_core_agent module configures installation sources for the Puppet Core packages and optionally installs the specified agent version.
Setup
What puppet_core_agent affects
RedHat - Creates /etc/yum.repo.d/puppet-core.repo ; Optionally installs puppet-agent
Ubuntu - Creates /etc/apt/sources.list.d/$puppet_release.list ; Creates /etc/apt/auth.conf ; Optionally installs puppet-agent
Windows - Executes PowerShell script to download MSI installer to C:\Windows\Temp\ ; Optionally installs agent from local MSI installer
Beginning with puppet_core_agent
A Forge API Key associated with an account that either has a Puppet Core entitlement or has accepted the Puppet Core EULA is required for module use. Please see the following Puppet Core documentation for further details purchase , limited-use
You will then need to install the puppet_core_agent module and relevant dependencies for your target operating system(s).
Usage
Classify target node(s) with the puppet_core_agent_class via a resource-like declaration such as:
class { 'puppet_core_agent':
forge_api_key => 'MYAPIKEY',
manage_package => true,
version => '8.11.0',
}
OR include puppet_core_agent and pass in your data via hiera with the respective keys.
puppet_core_agent::forge_api_key: MYAPIKEY
puppet_core_agent::manage_package: true
puppet_core_agent::version: 8.11.0
Reference
Table of Contents
Classes
puppet_core_agent: Configures Puppet Core repository and optionally manages the agent installpuppet_core_agent::package: Installs the puppet-agent core package to the specified versionpuppet_core_agent::repo: Configures Puppet Core repository
Classes
puppet_core_agent
Configures Puppet Core repository and optionally manages the agent install
Examples
Basic usage
class { 'puppet_core_agent':
forge_api_key => 'MYAPIKEY',
manage_package => true,
version => '8.11.0',
}
Parameters
The following parameters are available in the puppet_core_agent class:
forge_api_key
Data type: String
Forge API Key associated with an account that has signed the Puppet Core EULA
manage_package
Data type: Boolean
Toggle if you want the agent package managed or not
version
Data type: String
Specify the target puppet core agent version
puppet_core_agent::package
Installs the puppet-agent core package to the specified version
Examples
include puppet_core_agent::package
puppet_core_agent::repo
Configures Puppet Core repository
Examples
include puppet_core_agent::repo
Dependencies
- puppetlabs/apt (>= 10.0.1 < 11.0.0)
- puppetlabs/powershell (>= 6.0.2 < 7.0.0)
- puppetlabs/pwshlib (>= 1.2.2 < 2.0.0)
- puppetlabs/stdlib (>= 9.7.0 < 10.0.0)
- puppetlabs/yumrepo_core (>= 2.1.0 < 3.0.0)
MIT License Copyright (c) 2025 Kevin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.