confdroid/confdroid_apache
3
0
Fork 0
Code Issues Projects Wiki Activity

EN-0001 - rewrite README

Browse Source
This commit is contained in:
Arne Teuke
2021-08-05 16:02:58 +02:00
parent fff4fbb07c
commit f14bc2d1bb
1 changed files with 27 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@@ -1,32 +1,19 @@
[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_apache)](https://pipelines.confdroid.com/job/cd_apache/) # README.md
### Synopsis [![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_apache)](https://pipelines.confdroid.com/job/cd_apache/)|
[[_TOC_]]
## Synopsis
`Apache httpd` is a very powerful and widely used web server. `Apache httpd` is a very powerful and widely used web server.
`cd_apache` automates the installation and configuration of httpd. This module is a base module simply providing the httpd service itself to be used by other role- or profile modules, adding more detailed configurations specific to the particular use case. `cd_apache` automates the installation and configuration of httpd. This module is a base module simply providing the httpd service itself to be used by other role- or profile modules, adding more detailed configurations specific to the particular use case.
### 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 previuos 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 previuos 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!!! __**`
### Table of Contents
* [Features](#features)
* [Repo Structure](#repo-structure)
* [Dependencies](#dependencies)
* [Deployment](#deployment)
* [native Puppet deployment](#native-puppet-deployment)
* [through Foreman](#through-foreman)
* [Parameters](#parameters)
* [Mandatory Parameters](#mandatory-parameters)
* [Optional Parameters](#optional-parameters)
* [SELINUX](#selinux)
* [Known Problems](#known-problems)
* [Support](#support)
* [Tests](#tests)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)
## Features
### Features
Installation Installation
* install required binaries and dependencies * install required binaries and dependencies
@@ -41,8 +28,8 @@ Configuration
Maintenance Maintenance
* manage the service * manage the service
#### vHosts ### vHosts
As stated in the ynopsis, this module was written particularly for usage as base module. `Apache httpd` has a great number of usae cases where it actually is not used directly as full blown webser, but instead as 'sub-service'. Examples here would be As stated in the synopsis, this module was written particularly for usage as base module. `Apache httpd` has a great number of usae cases where it actually is not used directly as full blown webser, but instead as 'sub-service'. Examples here would be
* frontend proxy for other applications to avoid having to put the port number into the URL * frontend proxy for other applications to avoid having to put the port number into the URL
* applications like phpMyAdmin, phpPgAdmin * applications like phpMyAdmin, phpPgAdmin
@@ -51,53 +38,43 @@ As stated in the ynopsis, this module was written particularly for usage as base
With those use cases, you would provide the vHosts at the Puppet module for the application, not the base module. Also, if you plan to use this module to run a plain fully fledged web server, you would use a role- or profile class/module on top of `cd_apache` to set up your vHost exactly as needed. Examples for regular basic vHost configuration files are included in the examples directory as parameterized .erb files. You would create a define for vhosts, i.e. using the example parameters, and simply add `cd_apache` as requirement (i.e. require cd_apache) so it gets installed automatically. With those use cases, you would provide the vHosts at the Puppet module for the application, not the base module. Also, if you plan to use this module to run a plain fully fledged web server, you would use a role- or profile class/module on top of `cd_apache` to set up your vHost exactly as needed. Examples for regular basic vHost configuration files are included in the examples directory as parameterized .erb files. You would create a define for vhosts, i.e. using the example parameters, and simply add `cd_apache` as requirement (i.e. require cd_apache) so it gets installed automatically.
### Repo Structure
Repostructure as been moved to REPOSTRUCTURE.md
### Dependencies ### Dependencies
All dependencies must be included in the catalogue. All dependencies must be included in the catalogue.
* [cd_resources](https://gitlab.confdroid.com/12WW1160/cd_resources) * [cd_resources](https://gitlab.confdroid.com/12WW1160/cd_resources)
### Deployment ## Deployment
##### native Puppet deployment * native Puppet deployment
via site.pp or nodes.pp via site.pp or nodes.pp
``` ```bash
node 'example.example.net' { node 'example.example.net' {
include cd_puppetdb include cd_puppetdb
} }
``` ```
#### through Foreman: * through Foreman:
In order to apply parameters through Foreman, **__cd_apache::params__** must be added to the host or hostgroup in question. In order to apply parameters through Foreman, **__cd_apache::params__** must be added to the host or hostgroup in question.
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/). See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
### Parameters ## Parameters
The following parameters are editable via params.pp or through ENC (**__recommended__**). Values changed will take immediate effect at next puppet run. Services will be restarted where neccessary.
#### Mandatory Parameters The parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.
#### Optional Parameters ## SELINUX
* `$ae_manage_user` : Whether or not to manage the user settings. Important when accessing shared resources accross nodes. Defaults to `false`.
* `$ae_manage_cfg` : Whether or not to manage the apache configuration. Defaults to `false` as this module is meant to be used through profiles or roles or other modules.
* `$ae_manage_dirs` : Whether or not to manage the directory structure. Defaults to `true`.
* `$ae_allow_user_dirs` : Whether or not to allow presenting content from end user home directories. Defaults to `false`.
### SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored. All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
### Known Problems ## Support
### Support
* OS: CentOS 7 * OS: CentOS 7
* Puppet 5 * Puppet 5
### Tests ## Tests
* Puppet Lint * Puppet Lint
* excluded tests: * excluded tests:
* `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions * `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions
@@ -107,10 +84,15 @@ All files and directories are configured with correct selinux context. If selinu
* Puppet Parser * Puppet Parser
* ERB Template Parser * ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files) * Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
* Markdown-lint
* Spellcheck
* Sonar Quality Gate
## Contact Us
### Contact Us
[contact Us](https://confdroid.com/contact/) [contact Us](https://confdroid.com/contact/)
### Disclaimer ## Disclaimer
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments. 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. 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.