feat: cleanup excessive comments

This commit is contained in:
Ben Vincent 2024-05-19 17:23:00 +10:00
parent 2971018b7e
commit 150d5b97a9
4 changed files with 1 additions and 114 deletions

View File

@ -2,32 +2,6 @@
# #
# This class manages the 'base', extras' and 'appstream' yum # This class manages the 'base', extras' and 'appstream' yum
# repositories for a system, based on the provided list of managed repositories. # repositories for a system, based on the provided list of managed repositories.
#
# Parameters:
# -----------
# - $managed_repos: An array containing the names of the repositories to be
# managed. This can include 'base', 'extras',
# and 'appstream'.
#
# - $baseurl: The base URL for the yum repositories. This should be the root
# URL of your yum mirror server.
#
# Actions:
# --------
# - Sets up the 'base', extras', and 'appstream' yum repositories
# as specified in the $managed_repos parameter, all using the provided baseurl.
#
# - Each repo configuration includes the baseurl parameterized with the OS
# release version and architecture, and specifies the GPG key.
#
# Example usage:
# --------------
# To use this class with the default parameters:
# class { 'profiles::yum::base':
# managed_repos => ['base', 'extras', 'appstream'],
# baseurl => 'http://mylocalmirror.com/yum',
# }
#
class profiles::yum::base ( class profiles::yum::base (
Array[String] $managed_repos, Array[String] $managed_repos,
String $baseurl, String $baseurl,

View File

@ -1,29 +1,6 @@
# Class: profiles::yum::epel # Class: profiles::yum::epel
# #
# This class manages the EPEL yum repository for the system. # This class manages the EPEL yum repository for the system.
#
# Parameters:
# -----------
# - $baseurl: The base URL for the EPEL yum repository. This should be the root
# URL of your EPEL mirror server.
#
# Actions:
# --------
# - Checks the OS release version.
#
# - If the release version is 7, 8, or 9, it sets up the 'epel' yum repository
#
# - If the release version is not supported, it raises an error.
#
# Example usage:
# --------------
# To use this class with the default parameters:
# include profiles::yum::epel
#
# To specify a custom base URL:
# class { 'profiles::yum::epel':
# baseurl => 'http://mylocalmirror.com/yum',
# }
class profiles::yum::epel ( class profiles::yum::epel (
Array[String] $managed_repos, Array[String] $managed_repos,
String $baseurl, String $baseurl,

View File

@ -3,43 +3,6 @@
# This class manages global YUM configurations and optionally includes the # This class manages global YUM configurations and optionally includes the
# base and EPEL yum repository profiles based on the content of the # base and EPEL yum repository profiles based on the content of the
# $managed_repos parameter, which is an array of repository names. # $managed_repos parameter, which is an array of repository names.
#
# Parameters:
# -----------
# - $managed_repos: An array of repository names that the Puppet agent should
# manage. This parameter is mandatory and the class will
# fail if it is not provided via hieradata.
# Example: ['base', 'updates', 'extras', 'appstream']
#
# Actions:
# --------
# - Configures global YUM settings, including keeping the kernel development
# packages and cleaning old kernels.
#
# - Establishes default parameters for any YUM repositories managed by Puppet.
# This includes the repository file location, the repository description,
# and enabling the repository and GPG checks.
#
# - Depending on the content of the $managed_repos parameter, it includes the
# profiles::yum::base and/or profiles::yum::epel classes.
#
# - Manages all .repo files under /etc/yum.repos.d. All the repositories listed
# in $managed_repos will have their corresponding .repo files preserved. Any
# .repo file that is not listed in $managed_repos will be removed.
#
# - Creates and maintains a /etc/yum.repos.d/.managed file that lists all the
# .repo files that should be managed by Puppet.
#
# Example usage:
# --------------
# To use this class, include the class and configure hieradata:
# include profiles::yum::global
#
# profiles::yum::managed_repos:
# - 'base'
# - 'extras'
# - 'appstream'
#
class profiles::yum::global ( class profiles::yum::global (
Array[String] $managed_repos, Array[String] $managed_repos,
Boolean $purge = true, Boolean $purge = true,

View File

@ -1,33 +1,6 @@
# Class: profiles::yum::epel # Class: profiles::yum::epel
# #
# This class manages the puppet7 yum repository for the system. # This class manages the puppet7 yum repository for the system.
#
# Parameters:
# -----------
# - $baseurl: The base URL for the puppet7 yum repository. This should be the root
# URL of your puppet7 mirror server.
#
# Actions:
# --------
# - Checks the OS release version.
#
# - If the release version is 7, 8, or 9, it sets up the 'puppet7' yum repository
# and installs the puppet7 release RPM from the provided baseurl.
#
# - If the release version is not supported, it raises an error.
#
# - The repo configuration includes the baseurl parameterized with the OS
# release version and architecture, and specifies the GPG key.
#
# Example usage:
# --------------
# To use this class with the default parameters:
# include profiles::yum::puppet7
#
# To specify a custom base URL:
# class { 'profiles::yum::puppet7':
# baseurl => 'http://mylocalmirror.com/yum',
# }
class profiles::yum::puppet7 ( class profiles::yum::puppet7 (
Array[String] $managed_repos, Array[String] $managed_repos,
String $baseurl = 'http://repos.main.unkin.net/puppet7', String $baseurl = 'http://repos.main.unkin.net/puppet7',