apache-formula

A saltstack formula to configure apache.

This formula has been developed distributing declarations in different files to make it usable in most situations. It should be useful in scenarios ranging from a simple install of the packages (without any special configuration) to a more complex set-up with different virtual hosts.

General customization strategies

• Use pillar data. This is the absolutely recommended way to use the formula. In most occassions all you need is to fill some of the key-values shown in the pillar.example file. If you feel that a certain value should be there then don't hesitate to propose an enhancement.

• Use the extra_conf key that in some cases is present in the pillar to add arbitrary configuration lines in the templates provided. This is a way to have a better customization without over-populating the pillar with new key-values.

• Add new subdirectories under files in addition to default. This new subdirectories will contain different files to be used in certain conditions. This selection mechanism is based by default in the ìd grain of the minion (i.e. if there's a new subdirectory named minion01 then the formula is going to look there first for that minion). This selection behavior can be extended to make it depend on any sorted list of grains, defined by the key files_switch.

  For example, let's define in pillar something like:

  formula-name:
    files_switch: ['id', 'os_family']

  Let's have this files directory structure:

  files
    |-- minion01
    |       `-- etc
    |            `-- foo.conf.jinja
    |-- Debian
    |       `-- etc
    |            `-- foo.conf.jinja
    `-- default
            |-- etc
            |    |-- foo.conf.jinja
            |    `-- bar.conf.jinja
            `-- usr/share/thingy/*

  With this, we have the following:

  • if the minion id is minion01 then files/minion01/etc/foo.conf.jinja is going to be used
  • else if the minion os_family is Debian then files/Debian/etc/foo.conf.jinja is going to be used
  • else files/default/etc/foo.conf.jinja is going to be used

  Beware: this is not designed to substitute pillar data. Remember that pillar has to be used for information that it's essential to be only known for a certain set of minions (i.e. passwords, private keys and such).

• As a last resort you can actually fork the formula to suit your needs, keeping an eye for further improvements to merge into yours. Of course any pull- request that you can bring back it would be taken in account ;-)

Note

So far this formula is mostly designed for Debian os_family and apache 2.4.x. Support for RedHat os_family will appear one of these days.

At this moment, the organization of sites (we can assume site == virtual host) is completelly based in a Debian os_family organization. Soon I'll try to implement the RedHat flavor that drops everything in a conf.d directory.

See the full Salt Formulas doc.

Available states

• apache
• apache.conf
• apache.repo
• apache.users
• apache.mod_mpm
• apache.mod_actions
• apache.mod_pagespeed
• apache.mod_proxy
• apache.mod_proxy_fcgi
• apache.mod_rewrite

apache

Installs the package and starts the associated service.

apache.conf

Configures the service and sites using info provided in pillar and templates.

apache.repo

Configures a repository to get alternative (usually updated) versions of the packages different than the ones provided by the default repository.

apache.users

Declares users and groups that could be needed even in other formulas (e.g. in the users formula to make an user pertain to the service group).

apache.mod_mpm

Configures the mpm module selected in the pillar (default is mpm_prefork).

apache.mod_actions

Installs the mod_actions module.

apache.mod_pagespeed

Installs the mod_pagespeed module.

apache.mod_proxy

Installs the mod_proxy module.

apache.mod_proxy_fcgi

Installs the mod_proxy_fcgi module.

apache.mod_rewrite

Installs the mod_rewrite module.