Files
confdroid_php/README.md
2026-02-07 16:01:48 +01:00

70 lines
3.3 KiB
Markdown

# Readme
[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_php)](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)
- [Readme](#readme)
- [Synopsis](#synopsis)
- [WARNING](#warning)
- [Features](#features)
- [Support](#support)
- [Parameter Inheritance](#parameter-inheritance)
- [Module Deployment](#module-deployment)
- [Tests](#tests)
- [Contact Us](#contact-us)
- [Disclaimer](#disclaimer)
## Synopsis
Php is a widely used open source scripting language for web services.
`confdroid_php` manages plain php installations for use with other modules like `confdroid_nagios`. PHP is installed and properly configured to allow multiple applications with different settings to run in parallel. Custom php.ini settings should be configured with the application.
## 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***
## Features
- install php
- manage required directories including selinux contexts and permissions
- manage reuired files including selinux contexts and permissions
## Support
* Rocky 9
* Puppet 8
# 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.
## Module Deployment
ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes [Foreman][def] as ENC, so the modules just have to be present on the master node and Foreman will take care for it.
## Tests
* Puppet Lint
* 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.
* Puppet Parser
* ERB Template Parser
* Sonar Quality Gate
## Contact Us
[contact Us](https://confdroid.com/contact/)
## Disclaimer
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.
[def]: https://www.theforeman.org/manuals/3.13/quickstart_guide.html