site/profiles/manifests/puppet/autosign.pp

@@ -4,35 +4,6 @@
 # based on specified subnet ranges and domain patterns. 
 # It is useful in environments where nodes are dynamically provisioned and 
 # require automatic certificate signing without manual intervention.
-#
-# Parameters:
-#   - `subnet_ranges`: An array of IP subnet ranges in CIDR notation.
-#       Nodes with IP addresses within these ranges will have their 
-#       certificates autosigned. 
-#       Default: []
-#       Example: ['198.18.17.0/24']
-#
-#   - `domains`: An array of domain patterns.
-#       Nodes with hostnames matching these patterns will have their
-#       certificates autosigned.
-#       Default: []
-#       Example: ['*.main.unkin.net', '*.secondary.unkin.net']
-#
-#   - `nodes`: An array of specific node names.
-#       Nodes with hostnames matching these will have their
-#       certificates autosigned.
-#       Default: []
-#       Example: ['somenode.main.unkin.net', 'othernode.secondary.unkin.net']
-# Usage:
-# 
-# To include this class with custom parameters:
-#   class { 'profiles::puppet::autosign':
-#     subnet_ranges => ['198.18.17.0/24', '198.18.18.0/24'],
-#     domains       => ['*.main.unkin.net', '*.dev.unkin.net'],
-#     nodes         => ['somenode.main.unkin.net', 'othernode.dev.unkin.net'],
-#   }
-#
-# Alternatively, configure subnet ranges and domains through Hiera.
 class profiles::puppet::autosign (
   Array[Stdlib::IP::Address::V4::CIDR] $subnet_ranges = [],
   Array[String[1]] $domains = [],

site/profiles/manifests/puppet/enc.pp

@@ -4,35 +4,6 @@
 # systemd service and timer to keep the repository updated every minute.
 # The Git package is installed if not present, and the repository at the given 
 # location will always reflect the state of the remote Git repository.
-#
-# Parameters:
-# - enc_repo: The URL of the Git repository to clone.
-#
-# Actions:
-# - Ensures the Git package is installed.
-# - Ensures the /opt/puppetlabs/enc directory is a clone of the given Git repository.
-# - Creates a helper script '/opt/puppetlabs/bin/git_update' for updating the Git repository.
-# - Creates a systemd service and timer that runs the git update script every minute.
-#
-# Usage:
-#   Directly include the class in your node definitions or classify your nodes 
-#   using an ENC or Hiera.
-#   Example:
-#     node 'puppet.example.com' {
-#       class { 'profiles::puppet::enc':
-#         enc_repo => 'https://github.com/user/repo.git',
-#       }
-#     }
-#
-# Requirements:
-# - The 'puppet-vcsrepo' module should be installed on your puppetmaster.
-# - The 'puppet-systemd' module should be installed on your puppetmaster.
-# - '/opt/puppetlabs/bin/' directory must exist and be writable.
-# - Puppet master must have access to the specified Git URL.
-#
-# Limitations:
-# This is designed to work on Unix-like systems only.
-#
 class profiles::puppet::enc (
   String $repo,
   String $release = 'master',

site/profiles/manifests/puppet/g10k.pp

@@ -5,31 +5,6 @@
 # The latest release of g10k is downloaded from GitHub and placed into '/opt/puppetlabs/bin'.
 # Additionally, it creates a helper script to easily run g10k with the appropriate configuration.
 # It also creates a systemd service and timer that runs the g10k script every minute.
-#
-# Parameters: None
-#
-# Actions:
-# - Downloads the latest g10k release from GitHub.
-# - Extracts the download and places the executable in '/opt/puppetlabs/bin'.
-# - Creates a helper script '/opt/puppetlabs/bin/puppet-g10k' for easy usage of g10k.
-# - Creates a systemd service and timer that runs the g10k script every minute.
-#
-# Usage:
-#   Directly including the class in your node definitions or classify your nodes 
-#   using an ENC or Hiera.
-#   Example:
-#     node 'puppet.example.com' {
-#       include profiles::puppet::g10k
-#     }
-#
-# Requirements:
-# - The 'puppet-archive' module should be installed in your puppetmaster.
-# - The 'puppet-systemd' module should be installed on your puppetmaster.
-# - '/opt/puppetlabs/bin/' directory must exist and be writable.
-# - Puppet master must have access to the GitHub URL.
-#
-# Limitations:
-# This is designed to work on Unix-like systems only.
 class profiles::puppet::g10k (
   String $bin_path,
   String $cfg_path,

site/profiles/manifests/puppet/puppetmaster.pp

@@ -2,26 +2,6 @@
 #
 # This class manages the puppetmaster using the ghoneycutt-puppet module.
 # It manages the server settings in the puppet.conf file.
-#
-# Parameters: None
-#
-# Actions:
-# - Sets up the server, main, agent, and master sections in the puppet.conf file
-#
-# Usage:
-#   Directly include the class in your node definitions or classify your nodes 
-#   using an ENC or Hiera.
-#   Example:
-#     node 'puppet.example.com' {
-#       include profiles::puppet::puppetmaster
-#     }
-#
-# Requirements:
-# - The 'ghoneycutt/puppet' module should be installed in your Puppet master.
-# - Puppet master must have access to the necessary directories.
-#
-# Limitations:
-# This is designed to work on Unix-like systems.
 class profiles::puppet::puppetmaster (
   Optional[Stdlib::Fqdn] $puppetdb_host = lookup('profiles::puppet::puppetdb::puppetdb_host', Optional[Stdlib::Fqdn], 'first', undef),
 ) {

site/profiles/manifests/puppet/r10k.pp

@@ -4,35 +4,6 @@
 # systemd service and timer to keep the repository updated every minute.
 # The Git package is installed if not present, and the repository at the given 
 # location will always reflect the state of the remote Git repository.
-#
-# Parameters:
-# - r10k_repo: The URL of the Git repository to clone.
-#
-# Actions:
-# - Ensures the Git package is installed.
-# - Ensures the /etc/puppetlabs/r10k directory is a clone of the given Git repository.
-# - Creates a helper script '/opt/puppetlabs/bin/puppet-r10k' for updating the Git repository.
-# - Creates a systemd service and timer that runs the git update script every minute.
-#
-# Usage:
-#   Directly include the class in your node definitions or classify your nodes 
-#   using an enc or Hiera.
-#   Example:
-#     node 'puppet.example.com' {
-#       class { 'profiles::puppet::r10k':
-#         r10k_repo => 'https://github.com/user/repo.git',
-#       }
-#     }
-#
-# Requirements:
-# - The 'puppet-vcsrepo' module should be installed on your puppetmaster.
-# - The 'puppet-systemd' module should be installed on your puppetmaster.
-# - '/opt/puppetlabs/bin/' directory must exist and be writable.
-# - Puppet master must have access to the specified Git URL.
-#
-# Limitations:
-# This is designed to work on Unix-like systems only.
-#
 class profiles::puppet::r10k (
   String $r10k_repo,
 ){

site/profiles/manifests/puppet/server.pp

@@ -1,19 +1,6 @@
 # Class: profiles::puppet::server
 #
 # This class manages Puppet server's configuration and service.
-#
-# Parameters:
-#   vardir - Directory path for variable data.
-#   logdir - Directory path for logs.
-#   rundir - Directory path for run-time data.
-#   pidfile - File path for the PID file.
-#   codedir - Directory path for code data.
-#   dns_alt_names - Array of alternate DNS names for the server.
-#   agent_server - Server name for the puppet agent on the master.
-#   node_terminus - Node terminus.
-#   external_nodes - Path to the external node classifier script.
-#   autosign - Path to the autosign script.
-#
 class profiles::puppet::server (
   Stdlib::Absolutepath $vardir    = '/opt/puppetlabs/server/data/puppetserver',
   Stdlib::Absolutepath $logdir    = '/var/log/puppetlabs/puppetserver',