puppetlabs / puppetlabs/puppetlabs-apache
forensics module should not installed by default
Nobody has claimed this yet.
- Dominant language
- Puppet
- Stars
- 356
- Forks
- 1.1k
- Avg merge
- 3m
- Merged PRs (30d)
- 1
Description
Describe the Bug
In https://github.com/puppetlabs/puppetlabs-apache/pull/2442 the forensics module was added to the relatively small set of default installed plugins but there wasn't clear rational given why.
The "hack" needed to enable it is the same as for all plugins, e.g.
class { 'apache::mod::forensics': }
# or via hiera defined classes lookup('classes', Array[String], 'unique').include
classes:
- apache::mod::forensics
As the forensics module does not appear to be a particular commonly used module it should not be in the default set unconditionally:
https://github.com/puppetlabs/puppetlabs-apache/blob/main/manifests/default_mods.pp#L123
If I am mistaken in this assumption please instead add a clearer rational to why it is added as a source code comment to avoid confusion in the future.
Expected Behavior
The default configuration installs the minimal needed set of plugin or at least allow disabling this optional one.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing manifests/default_mods.pp around line 123 and the linked pull request to understand why the forensics module was added to the defaults. Done should mean the default configuration no longer installs this optional module while the explicit apache::mod::forensics class still enables it, or that a clear source comment explains why it remains.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- apache
- Domain
- devops
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100