Puppet Class: profile::nginx

Defined in:
modules/profile/manifests/nginx.pp

Summary

wrapper profile to install and configure nginx for a profile

Overview

Parameters:

  • ensure (Wmflib::Ensure) (defaults to: lookup('profile::nginx::ensure')) —

    whether to ensure the resource

  • managed (Boolean) (defaults to: lookup('profile::nginx::managed')) —

    If true (the default), changes to Nginx configuration files and site definition files will trigger a restart of the Nginx server. If false, the service will need to be manually restarted for the configuration changes to take effect.

  • variant (Enum['full', 'extras', 'light', 'custom']) (defaults to: lookup('profile::nginx::variant')) —

    nginx in Debian provides three different Debian packages (nginx-light, nginx-extras and nginx-full) which enable different levels of built-in modules (which are provided out of the box) and available addons (which need to be installed via libnginx-mod-foo). For most use cases nginx-light will do just fine and it's recommended to stick with it unless you have a specific need for a module not present there. This reduces risks since less code needs to be loaded (and also fewer libraries, e.g. nginx-extras ships the an image filter which pulls in libgd). You can see the list of enabled modules via “apt show nginx-foo Starting with Bookworm there is a single nginx binary and additional functionality can be installed via libnginx-mod-http-foo packages. Use ”custom“ and the profile::nginx::modules variable to use that scheme.

  • modules (Array[String]) (defaults to: lookup('profile::nginx::modules')) —

    If using variant=custom (Bookworm and later), install these additional packages

  • lib_on_tmpfs (Boolean) (defaults to: lookup('profile::nginx::lib_on_tmpfs')) —

    Mount /var/lib/nginx on a tmpfs volume to reduce disk writes

  • tmpfs_size (String) (defaults to: lookup('profile::nginx::tmpfs_size')) —

    The /var/lib/nginx tmpfs size



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'modules/profile/manifests/nginx.pp', line 21

class profile::nginx (
    Wmflib::Ensure                            $ensure       = lookup('profile::nginx::ensure'),
    Boolean                                   $managed      = lookup('profile::nginx::managed'),
    Enum['full', 'extras', 'light', 'custom'] $variant      = lookup('profile::nginx::variant'),
    Boolean                                   $lib_on_tmpfs = lookup('profile::nginx::lib_on_tmpfs'),
    String                                    $tmpfs_size   = lookup('profile::nginx::tmpfs_size'),
    Array[String]                             $modules      = lookup('profile::nginx::modules'),
) {
    class {'nginx':
        ensure       => $ensure,
        managed      => $managed,
        variant      => $variant,
        lib_on_tmpfs => $lib_on_tmpfs,
        tmpfs_size   => $tmpfs_size,
        modules      => $modules,
    }
}