Puppet Class: php::fpm

Defined in:
manifests/fpm.pp

Overview

Install and configure mod_php for fpm

Parameters

user

The user that php-fpm should run as

group

The group that php-fpm should run as

service_enable

Enable/disable FPM service

service_ensure

Ensure FPM service is either ‘running’ or ‘stopped’

service_name

This is the name of the php-fpm service. It defaults to reasonable OS defaults but can be different in case of using php7.0/other OS/custom fpm service

service_provider

This is the name of the service provider, in case there is a non OS default service provider used to start FPM. Defaults to ‘undef’, pick system defaults.

pools

Hash of php::fpm::pool resources that will be created. Defaults to a single php::fpm::pool named www with default parameters.

log_owner

The php-fpm log owner

log_group

The group owning php-fpm logs

package

Specify which package to install

ensure

Specify which version of the package to install

inifile

Path to php.ini for fpm

settings

fpm settings hash

global_pool_settings

Hash of defaults params php::fpm::pool resources that will be created. Defaults is empty hash.

pool_purge

Whether to purge pool config files not created by this module

reload_fpm_on_config_changes

by default, we reload the service on changes. But certain options, like socket owner, will only be applied during a restart. If set to false, a restart will be executed instead of a reload. This default will be changed in a future release.

Parameters:

  • ensure (Optional[String]) (defaults to: $php::ensure)
  • user (String[1]) (defaults to: $php::fpm_user)
  • group (String[1]) (defaults to: $php::fpm_group)
  • service_ensure (Enum['running', 'stopped']) (defaults to: $php::fpm_service_ensure)
  • service_enable (Boolean) (defaults to: $php::fpm_service_enable)
  • service_name (String[1]) (defaults to: $php::fpm_service_name)
  • service_provider (Optional[String[1]]) (defaults to: $php::fpm_service_provider)
  • package (String) (defaults to: $php::real_fpm_package)
  • inifile (Stdlib::Absolutepath) (defaults to: $php::fpm_inifile)
  • settings (Hash) (defaults to: $php::real_settings)
  • global_pool_settings (Hash) (defaults to: $php::real_fpm_global_pool_settings)
  • pools (Hash) (defaults to: $php::real_fpm_pools)
  • log_owner (String[1]) (defaults to: $php::log_owner)
  • log_group (String[1]) (defaults to: $php::log_group)
  • pool_purge (Boolean) (defaults to: $php::pool_purge)
  • reload_fpm_on_config_changes (Boolean) (defaults to: $php::reload_fpm_on_config_changes) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'manifests/fpm.pp', line 62

class php::fpm (
  Optional[String] $ensure              = $php::ensure,
  String[1] $user                       = $php::fpm_user,
  String[1] $group                      = $php::fpm_group,
  Enum['running', 'stopped'] $service_ensure = $php::fpm_service_ensure,
  Boolean $service_enable               = $php::fpm_service_enable,
  String[1] $service_name               = $php::fpm_service_name,
  Optional[String[1]] $service_provider = $php::fpm_service_provider,
  String $package                       = $php::real_fpm_package,
  Stdlib::Absolutepath $inifile         = $php::fpm_inifile,
  Hash $settings                        = $php::real_settings,
  Hash $global_pool_settings            = $php::real_fpm_global_pool_settings,
  Hash $pools                           = $php::real_fpm_pools,
  String[1] $log_owner                  = $php::log_owner,
  String[1] $log_group                  = $php::log_group,
  Boolean $pool_purge                   = $php::pool_purge,
  Boolean $reload_fpm_on_config_changes = $php::reload_fpm_on_config_changes,
) {
  if ! defined(Class['php']) {
    warning('php::fpm is private')
  }

  $real_settings = $settings

  # On FreeBSD fpm is not a separate package, but included in the 'php' package.
  # Implies that the option SET+=FPM was set when building the port.
  $real_package = $facts['os']['family'] ? {
    'FreeBSD' => [],
    default   => $package,
  }

  package { $real_package:
    ensure  => $ensure,
    require => Class['php::packages'],
  }

  class { 'php::fpm::config':
    user       => $user,
    group      => $group,
    inifile    => $inifile,
    settings   => $real_settings,
    log_owner  => $log_owner,
    log_group  => $log_group,
    pool_purge => $pool_purge,
    require    => Package[$real_package],
  }

  contain 'php::fpm::config'
  contain 'php::fpm::service'

  Class['php::fpm::config'] ~> Class['php::fpm::service']

  $real_global_pool_settings = $global_pool_settings
  $real_pools = $pools
  create_resources(::php::fpm::pool, $real_pools, $real_global_pool_settings)
}