Files
confdroid_apache/README.md

121 lines
5.7 KiB
Markdown
Raw Normal View History

2017-06-19 13:34:42 +01:00
|Repo Name| version | Build Status|
|---|---|---|---|
2017-07-11 18:14:21 +01:00
|`cd_apache`| 0.0.1.6 | [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=cd_apache)](https://jenkins.confdroid.com/job/cd_apache/)|
2017-06-19 13:34:42 +01:00
### Synopsis
2017-06-20 11:25:53 +01:00
`Apache httpd` is a very powerful and widely used web server.
2017-07-09 16:08:26 +01:00
`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.
2017-06-19 13:34:42 +01:00
### 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!!! __**`
### Table of Contents
* [Features](#features)
2017-07-07 16:21:28 +01:00
* [Repo Structure](#repo-structure)
2017-06-19 13:34:42 +01:00
* [Dependencies](#dependencies)
* [Deployment](#deployment)
* [native Puppet deployment](#native-puppet-deployment)
* [through Foreman](#through-foreman)
* [Parameters](#parameters)
2017-06-19 15:33:27 +01:00
* [Mandatory Parameters](#mandatory-parameters)
* [Optional Parameters](#optional-parameters)
2017-06-19 13:34:42 +01:00
* [SELINUX](#selinux)
* [Known Problems](#known-problems)
* [Support](#support)
* [Tests](#tests)
* [Changelog](https://gitlab.puppetsoft.com/12WW1160/cd_apache/blob/master/CHANGELOG.md#changelog)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)
### Features
2017-07-07 17:38:00 +01:00
Installation
2017-06-19 14:32:14 +01:00
* install required binaries and dependencies
2017-07-07 17:40:31 +01:00
2017-07-07 17:38:00 +01:00
Configuration
2017-06-19 15:33:27 +01:00
* manage user settings (optional)
* manage directory structure (optional)
2017-06-20 11:25:53 +01:00
* manage configuration files (optional):
* file system permissions
* selinux context
2017-07-07 17:38:00 +01:00
* manage firewall settings (optional)
Maintenance
2017-06-20 11:25:53 +01:00
* manage the service
2017-06-19 13:34:42 +01:00
2017-07-09 16:08:26 +01:00
#### 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
* frontend proxy for other applications to avoid having to put the port number into the URL
* applications like phpMyAdmin, phpPgAdmin
* WordPress
* Nagios etc.
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.
2017-07-09 16:08:26 +01:00
2017-06-19 13:34:42 +01:00
### Repo Structure
Repostructure as been moved to REPOSTRUCTURE.md
2017-06-19 13:34:42 +01:00
### Dependencies
All dependencies must be included in the catalogue.
2017-06-19 14:32:14 +01:00
* [cd_resources](https://gitlab.puppetsoft.com/12WW1160/cd_resources)
2017-06-19 13:34:42 +01:00
### Deployment
##### native Puppet deployment
via site.pp or nodes.pp
```
node 'example.example.net' {
include cd_puppetdb
}
```
#### through Foreman:
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/).
### 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.
2017-06-19 15:33:27 +01:00
#### Mandatory Parameters
#### Optional Parameters
2017-06-20 10:24:58 +01:00
* `$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`.
2017-06-19 15:33:27 +01:00
2017-06-19 13:34:42 +01:00
### SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
### Known Problems
### Support
* OS: CentOS 6, 7
### Tests
* Puppet Lint
* excluded tests:
* `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions
* `--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-80chars-check`: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault `params.pp`.
* `--no-arrow_alignment-check`: this check leads to actually not having am easily readable arrow alignment, as this checks `per block`, not per class.
* Puppet Parser
* ERB Template Parser
2017-07-11 17:56:04 +01:00
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
2017-06-19 13:34:42 +01:00
### 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.