Puppet Class: php

Inherits:
::php::params
Defined in:
manifests/init.pp

Overview

Base class with global configuration parameters that pulls in all enabled components.

=== Parameters

[ensure] Specify which version of PHP packages to install, defaults to 'present'. Please note that 'absent' to remove packages is not supported!

[manage_repos] Include repository (dotdeb, ppa, etc.) to install recent PHP from

[fpm] Install and configure php-fpm

[fpm_service_enable] Enable/disable FPM service

[fpm_service_ensure] Ensure FPM service is either 'running' or 'stopped'

[fpm_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

[fpm_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.

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

[fpm_global_pool_settings] Hash of defaults params php::fpm::pool resources that will be created. Defaults to empty hash.

[fpm_inifile] Path to php.ini for fpm

[fpm_package] Name of fpm package to install

[fpm_user] The user that php-fpm should run as

[fpm_group] The group that php-fpm should run as

[dev] Install php header files, needed to install pecl modules

[composer] Install and auto-update composer

[pear] Install PEAR

[phpunit] Install phpunit

[apache_config] Manage apache's mod_php configuration

[proxy_type] proxy server type (none|http|https|ftp)

[proxy_server] specify a proxy server, with port number if needed. ie: https://example.com:8080.

[extensions] Install PHP extensions, this is overwritten by hiera hash php::extensions

[package_prefix] This is the prefix for constructing names of php packages. This defaults to a sensible default depending on your operating system, like 'php-' or 'php5-'.

[config_root_ini] This is the path to the config .ini files of the extensions. This defaults to a sensible default depending on your operating system, like '/etc/php5/mods-available' or '/etc/php5/conf.d'.

[config_root_inifile] The path to the global php.ini file. This defaults to a sensible default depending on your operating system.

[ext_tool_enable] Absolute path to php tool for enabling extensions in debian/ubuntu systems. This defaults to '/usr/sbin/php5enmod'.

[ext_tool_query] Absolute path to php tool for querying information about extensions in debian/ubuntu systems. This defaults to '/usr/sbin/php5query'.

[ext_tool_enabled] Enable or disable the use of php tools on debian based systems debian/ubuntu systems. This defaults to 'true'.

[log_owner] The php-fpm log owner

[log_group] The group owning php-fpm logs

[embedded] Enable embedded SAPI

[pear_ensure] The package ensure of PHP pear to install and run pear auto_discover

[settings]

Parameters:

  • ensure (String) (defaults to: $::php::params::ensure)
  • manage_repos (Boolean) (defaults to: $::php::params::manage_repos)
  • fpm (Boolean) (defaults to: true)
  • fpm_service_enable (Any) (defaults to: $::php::params::fpm_service_enable)
  • fpm_service_ensure (Any) (defaults to: $::php::params::fpm_service_ensure)
  • fpm_service_name (Any) (defaults to: $::php::params::fpm_service_name)
  • fpm_service_provider (Any) (defaults to: undef)
  • fpm_pools (Hash) (defaults to: { 'www' => {} })
  • fpm_global_pool_settings (Hash) (defaults to: {})
  • fpm_inifile (Any) (defaults to: $::php::params::fpm_inifile)
  • fpm_package (Any) (defaults to: undef)
  • fpm_user (Any) (defaults to: $::php::params::fpm_user)
  • fpm_group (Any) (defaults to: $::php::params::fpm_group)
  • embedded (Boolean) (defaults to: false)
  • dev (Boolean) (defaults to: true)
  • composer (Boolean) (defaults to: true)
  • pear (Boolean) (defaults to: true)
  • pear_ensure (String) (defaults to: $::php::params::pear_ensure)
  • phpunit (Boolean) (defaults to: false)
  • apache_config (Boolean) (defaults to: false)
  • proxy_type (Any) (defaults to: undef)
  • proxy_server (Any) (defaults to: undef)
  • extensions (Hash) (defaults to: {})
  • settings (Hash) (defaults to: {})
  • package_prefix (Any) (defaults to: $::php::params::package_prefix)
  • config_root_ini (Stdlib::Absolutepath) (defaults to: $::php::params::config_root_ini)
  • config_root_inifile (Stdlib::Absolutepath) (defaults to: $::php::params::config_root_inifile)
  • ext_tool_enable (Optional[Stdlib::Absolutepath]) (defaults to: $::php::params::ext_tool_enable)
  • ext_tool_query (Optional[Stdlib::Absolutepath]) (defaults to: $::php::params::ext_tool_query)
  • ext_tool_enabled (Boolean) (defaults to: $::php::params::ext_tool_enabled)
  • log_owner (String) (defaults to: $::php::params::fpm_user)
  • log_group (String) (defaults to: $::php::params::fpm_group)


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'manifests/init.pp', line 115

class php (
  String $ensure                                  = $::php::params::ensure,
  Boolean $manage_repos                           = $::php::params::manage_repos,
  Boolean $fpm                                    = true,
  $fpm_service_enable                             = $::php::params::fpm_service_enable,
  $fpm_service_ensure                             = $::php::params::fpm_service_ensure,
  $fpm_service_name                               = $::php::params::fpm_service_name,
  $fpm_service_provider                           = undef,
  Hash $fpm_pools                                 = { 'www' => {} },
  Hash $fpm_global_pool_settings                  = {},
  $fpm_inifile                                    = $::php::params::fpm_inifile,
  $fpm_package                                    = undef,
  $fpm_user                                       = $::php::params::fpm_user,
  $fpm_group                                      = $::php::params::fpm_group,
  Boolean $embedded                               = false,
  Boolean $dev                                    = true,
  Boolean $composer                               = true,
  Boolean $pear                                   = true,
  String $pear_ensure                             = $::php::params::pear_ensure,
  Boolean $phpunit                                = false,
  Boolean $apache_config                          = false,
  $proxy_type                                     = undef,
  $proxy_server                                   = undef,
  Hash $extensions                                = {},
  Hash $settings                                  = {},
  $package_prefix                                 = $::php::params::package_prefix,
  Stdlib::Absolutepath $config_root_ini           = $::php::params::config_root_ini,
  Stdlib::Absolutepath $config_root_inifile       = $::php::params::config_root_inifile,
  Optional[Stdlib::Absolutepath] $ext_tool_enable = $::php::params::ext_tool_enable,
  Optional[Stdlib::Absolutepath] $ext_tool_query  = $::php::params::ext_tool_query,
  Boolean $ext_tool_enabled                       = $::php::params::ext_tool_enabled,
  String $log_owner                               = $::php::params::fpm_user,
  String $log_group                               = $::php::params::fpm_group,
) inherits ::php::params {

  $real_fpm_package = pick($fpm_package, "${package_prefix}${::php::params::fpm_package_suffix}")

  # Deep merge global php settings
  $real_settings = deep_merge($settings, hiera_hash('php::settings', {}))

  # Deep merge global php extensions
  $real_extensions = deep_merge($extensions, hiera_hash('php::extensions', {}))

  # Deep merge fpm_pools
  $real_fpm_pools = deep_merge($fpm_pools, hiera_hash('php::fpm_pools', {}))

  # Deep merge fpm_global_pool_settings
  $real_fpm_global_pool_settings = deep_merge($fpm_global_pool_settings, hiera_hash('php::fpm_global_pool_settings', {}))

  if $manage_repos {
    class { '::php::repo': }
    -> Anchor['php::begin']
  }

  anchor { 'php::begin': }
    -> class { '::php::packages': }
    -> class { '::php::cli':
      settings => $real_settings,
    }
  -> anchor { 'php::end': }

  # Configure global PHP settings in php.ini
  if $facts['os']['family'] != 'Debian' {
    Class['php::packages']
    -> class {'::php::global':
      settings => $real_settings,
    }
    -> Anchor['php::end']
  }

  if $fpm { contain '::php::fpm' }
  if $embedded {
    if $facts['os']['family'] == 'RedHat' and $fpm {
      # Both fpm and embeded SAPIs are using same php.ini
      fail('Enabling both cli and embedded sapis is not currently supported')
    }

    Anchor['php::begin']
      -> class { '::php::embedded':
        settings => $real_settings,
      }
    -> Anchor['php::end']
  }
  if $dev {
    Anchor['php::begin']
      -> class { '::php::dev': }
    -> Anchor['php::end']
  }
  if $composer {
    Anchor['php::begin']
      -> class { '::php::composer':
        proxy_type   => $proxy_type,
        proxy_server => $proxy_server,
      }
    -> Anchor['php::end']
  }
  if $pear {
    Anchor['php::begin']
      -> class { '::php::pear':
        ensure => $pear_ensure,
      }
    -> Anchor['php::end']
  }
  if $phpunit {
    Anchor['php::begin']
      -> class { '::php::phpunit': }
    -> Anchor['php::end']
  }
  if $apache_config {
    Anchor['php::begin']
      -> class { '::php::apache_config':
        settings => $real_settings,
      }
    -> Anchor['php::end']
  }

  create_resources('::php::extension', $real_extensions, {
    require => Class['::php::cli'],
    before  => Anchor['php::end']
  })

  # On FreeBSD purge the system-wide extensions.ini. It is going
  # to be replaced with per-module configuration files.
  if $::osfamily == 'FreeBSD' {
    # Purge the system-wide extensions.ini
    file { '/usr/local/etc/php/extensions.ini':
      ensure  => absent,
      require => Class['::php::packages'],
    }
  }
}