diff --git a/doc/file.README.html b/doc/file.README.html index 1b40b84..d7d53fa 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -58,11 +58,14 @@
-

|Repo Name| version | Build Status| |—|—|—|—| |cd_apache| -1.1.2.8 | README + +

|

-

Synopsis

+

[[TOC]]

+ +

Synopsis

Apache httpd is a very powerful and widely used web server.

@@ -71,69 +74,53 @@ 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 +

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 +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!!! __**

+production

-

Table of Contents

+

Features

+ +

Installation

-

Features

- -

Installation * install required binaries and dependencies

- -

Configuration * manage user settings (optional) * manage directory -structure (optional) * manage configuration files (optional): * file -system permissions * selinux context * manage firewall settings (optional) -* manage nagios monitoring (optional) Maintenance * manage the service

- -

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

+

Configuration

+ +

Maintenance

+ + +

vHosts

+ +

As stated in the synopsis, this module was written particularly for usage +as base module. Apache httpd has a great number of use cases +where it actually is not used directly as full-blown web server by itself, +but instead as platform for other applications. Examples here would be:

+
-

|Repo Name| version | Build Status| |—|—|—|—| |cd_apache| -1.1.2.8 | README + +

|

-

Synopsis

+

[[TOC]]

+ +

Synopsis

Apache httpd is a very powerful and widely used web server.

@@ -71,69 +74,53 @@ 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 +

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 +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!!! __**

+production

-

Table of Contents

+

Features

+ +

Installation

-

Features

- -

Installation * install required binaries and dependencies

- -

Configuration * manage user settings (optional) * manage directory -structure (optional) * manage configuration files (optional): * file -system permissions * selinux context * manage firewall settings (optional) -* manage nagios monitoring (optional) Maintenance * manage the service

- -

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

+

Configuration

  • -

    frontend proxy for other applications to avoid having to put the port +

    manage user settings (optional)

    +
  • +

    manage directory structure (optional)

    +
  • +

    manage configuration files (optional):

    +
  • +

    file system permissions

    +
  • +

    selinux context

    +
  • +

    manage firewall settings (optional)

    +
  • +

    manage nagios monitoring (optional)

    +
+ +

Maintenance

+
  • +

    manage the service

    +
+ +

vHosts

+ +

As stated in the synopsis, this module was written particularly for usage +as base module. Apache httpd has a great number of use cases +where it actually is not used directly as full-blown web server by itself, +but instead as platform for other applications. Examples here would be:

+
  • +

    front-end proxy for other applications to avoid having to put the port number into the URL

  • applications like phpMyAdmin, phpPgAdmin

    @@ -149,88 +136,64 @@ 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 +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

    All dependencies must be included in the catalogue.

    • cd_resources

      +href="https://sourcecode.confdroid.com/12WW1160/cd_resources">cd_resources

    -

    Deployment

    - -
    native Puppet deployment
    +

    Deployment

    +
    • +

      native Puppet deployment

      +

    via site.pp or nodes.pp

    node 'example.example.net' {
   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 +cd_apache::params must be added to the host or host group in question.

    See more details about class deployment on Confdroid.com.

    -

    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.

    +

    The parameters are documented via puppet strings and listed here. Simply open in web browser.

    -

    Mandatory Parameters

    - -

    Optional Parameters

    -
    • -

      $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

    +

    SELINUX

    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

    • Puppet 5

    -

    Tests

    +

    Tests

    • Puppet Lint

    • excluded tests:

      • -

        --no-class_inherits_from_params_class-check:relavant only to +

        --no-class_inherits_from_params_class-check:relevant only to non-supported outdated puppet versions

      • --no-variable_scope-check: not applicable as we are inheriting @@ -251,13 +214,19 @@ block, not per class.

        ERB Template Parser

      • 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

      -

      Disclaimer

      +

      Disclaimer

      ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific