update Readme

This commit is contained in:
2026-03-14 12:13:31 +01:00
parent 6852b2af78
commit 9cda55f30e

View File

@@ -1,22 +1,20 @@
# Readme # Readme
[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_php)](https://jenkins.confdroid.com/job/confdroid_php/) [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_php&style=plastic)](https://jenkins.confdroid.com/job/confdroid_php/)
[![Quality Gate Status](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_php&metric=alert_status&token=sqb_29de35ae9b31f21d0df8559554ea93a9856358b7)](https://sonarqube.confdroid.com/dashboard?id=confdroid_php)
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_php&metric=security_hotspots&token=sqb_29de35ae9b31f21d0df8559554ea93a9856358b7)](https://sonarqube.confdroid.com/dashboard?id=confdroid_php) [![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_php&metric=security_hotspots&token=sqb_29de35ae9b31f21d0df8559554ea93a9856358b7)](https://sonarqube.confdroid.com/dashboard?id=confdroid_php)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/grizzlycoda/puppet_collection)
- [Readme](#readme) - [Readme](#readme)
- [Synopsis](#synopsis) - [Synopsis](#synopsis)
- [WARNING](#warning) - [WARNING](#warning)
- [Features](#features) - [Features](#features)
- [Support](#support) - [Support](#support)
- [Parameter Inheritance](#parameter-inheritance) - [Parameter Inheritance](#parameter-inheritance)
- [Module Deployment](#module-deployment) - [Module Deployment](#module-deployment)
- [Tests](#tests) - [Tests](#tests)
- [Contact Us](#contact-us) - [Contact Us](#contact-us)
- [Disclaimer](#disclaimer) - [Disclaimer](#disclaimer)
## Synopsis ## Synopsis
Php is a widely used open source scripting language for web services. Php is a widely used open source scripting language for web services.
@@ -25,20 +23,20 @@ Php is a widely used open source scripting language for web services.
## WARNING ## WARNING
***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production*** > **Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production**
## Features ## Features
- install php - install php
- manage required directories including selinux contexts and permissions - manage required directories including selinux contexts and permissions
- manage reuired files including selinux contexts and permissions - manage required files including selinux contexts and permissions
## Support ## Support
* Rocky 9 - Rocky 9
* Puppet 8 - Puppet 8
# Parameter Inheritance ## Parameter Inheritance
All parameters are listed in `params.pp` and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable. All parameters are listed in `params.pp` and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.
@@ -48,13 +46,13 @@ ALmost every puppet setup is done in very custom ways, and hence the way the mod
## Tests ## Tests
* Puppet Lint - Puppet Lint
* excluded tests: - excluded tests:
* `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters. - `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
* Puppet Parser - Puppet Parser
* ERB Template Parser - ERB Template Parser
* Sonar Quality Gate - Sonar Quality Gate
## Contact Us ## Contact Us