Puppet Class: nginx

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

Overview

Class: nginx

This module manages NGINX.

Parameters:

Actions:

Requires:

puppetlabs-stdlib - https://github.com/puppetlabs/puppetlabs-stdlib

Packaged NGINX
  - RHEL: EPEL or custom package
  - Debian/Ubuntu: Default Install or custom package
  - SuSE: Default Install or custom package

stdlib
  - puppetlabs-stdlib module >= 0.1.6

Sample Usage:

The module works with sensible defaults:

node default

include nginx

Parameters:

  • client_body_temp_path (Any) (defaults to: $nginx::params::client_body_temp_path)
  • confd_only (Boolean) (defaults to: false)
  • confd_purge (Boolean) (defaults to: false)
  • conf_dir (Any) (defaults to: $nginx::params::conf_dir)
  • daemon (Optional[Enum['on', 'off']]) (defaults to: undef)
  • daemon_user (Any) (defaults to: $nginx::params::daemon_user)
  • daemon_group (Any) (defaults to: undef)
  • global_owner (Any) (defaults to: $nginx::params::global_owner)
  • global_group (Any) (defaults to: $nginx::params::global_group)
  • global_mode (Any) (defaults to: $nginx::params::global_mode)
  • log_dir (Any) (defaults to: $nginx::params::log_dir)
  • log_group (Any) (defaults to: $nginx::params::log_group)
  • log_mode (Any) (defaults to: '0750')
  • http_access_log (Variant[String, Array[String]]) (defaults to: "${log_dir}/${::nginx::params::http_access_log_file}")
  • http_format_log (Any) (defaults to: undef)
  • nginx_error_log (Variant[String, Array[String]]) (defaults to: "${log_dir}/${::nginx::params::nginx_error_log_file}")
  • nginx_error_log_severity (Nginx::ErrorLogSeverity) (defaults to: 'error')
  • pid (Any) (defaults to: $nginx::params::pid)
  • proxy_temp_path (Any) (defaults to: $nginx::params::proxy_temp_path)
  • root_group (Any) (defaults to: $nginx::params::root_group)
  • run_dir (Any) (defaults to: $nginx::params::run_dir)
  • sites_available_owner (Any) (defaults to: $nginx::params::sites_available_owner)
  • sites_available_group (Any) (defaults to: $nginx::params::sites_available_group)
  • sites_available_mode (Any) (defaults to: $nginx::params::sites_available_mode)
  • super_user (Boolean) (defaults to: $nginx::params::super_user)
  • temp_dir (Any) (defaults to: $nginx::params::temp_dir)
  • server_purge (Boolean) (defaults to: false)
  • conf_template (Any) (defaults to: 'nginx/conf.d/nginx.conf.erb')
  • accept_mutex (Any) (defaults to: 'on')
  • accept_mutex_delay (Any) (defaults to: '500ms')
  • client_body_buffer_size (Any) (defaults to: '128k')
  • client_max_body_size (String) (defaults to: '10m')
  • client_body_timeout (Any) (defaults to: '60s')
  • send_timeout (Any) (defaults to: '60s')
  • lingering_timeout (Any) (defaults to: '5s')
  • etag (Optional[Enum['on', 'off']]) (defaults to: undef)
  • events_use (Optional[String]) (defaults to: undef)
  • fastcgi_cache_inactive (String) (defaults to: '20m')
  • fastcgi_cache_key (Optional[String]) (defaults to: undef)
  • fastcgi_cache_keys_zone (String) (defaults to: 'd3:100m')
  • fastcgi_cache_levels (String) (defaults to: '1')
  • fastcgi_cache_max_size (String) (defaults to: '500m')
  • fastcgi_cache_path (Optional[String]) (defaults to: undef)
  • fastcgi_cache_use_stale (Optional[String]) (defaults to: undef)
  • gzip (Any) (defaults to: 'on')
  • gzip_buffers (Any) (defaults to: undef)
  • gzip_comp_level (Any) (defaults to: 1)
  • gzip_disable (Any) (defaults to: 'msie6')
  • gzip_min_length (Any) (defaults to: 20)
  • gzip_http_version (Any) (defaults to: 1.1)
  • gzip_proxied (Any) (defaults to: 'off')
  • gzip_types (Any) (defaults to: undef)
  • gzip_vary (Any) (defaults to: 'off')
  • http_cfg_prepend (Optional[Variant[Hash, Array]]) (defaults to: undef)
  • http_cfg_append (Optional[Variant[Hash, Array]]) (defaults to: undef)
  • http_raw_prepend (Optional[Variant[Array[String], String]]) (defaults to: undef)
  • http_raw_append (Optional[Variant[Array[String], String]]) (defaults to: undef)
  • http_tcp_nodelay (Any) (defaults to: 'on')
  • http_tcp_nopush (Any) (defaults to: 'off')
  • keepalive_timeout (Any) (defaults to: '65s')
  • keepalive_requests (Any) (defaults to: '100')
  • log_format (Any) (defaults to: {})
  • mail (Boolean) (defaults to: false)
  • stream (Boolean) (defaults to: false)
  • multi_accept (String) (defaults to: 'off')
  • names_hash_bucket_size (Integer) (defaults to: 64)
  • names_hash_max_size (Integer) (defaults to: 512)
  • nginx_cfg_prepend (Any) (defaults to: false)
  • proxy_buffers (String) (defaults to: '32 4k')
  • proxy_buffer_size (String) (defaults to: '8k')
  • proxy_cache_inactive (String) (defaults to: '20m')
  • proxy_cache_keys_zone (String) (defaults to: 'd2:100m')
  • proxy_cache_levels (String) (defaults to: '1')
  • proxy_cache_max_size (String) (defaults to: '500m')
  • proxy_cache_path (Optional[Variant[Hash, String]]) (defaults to: undef)
  • proxy_cache_loader_files (Optional[Integer]) (defaults to: undef)
  • proxy_cache_loader_sleep (Optional[String]) (defaults to: undef)
  • proxy_cache_loader_threshold (Optional[String]) (defaults to: undef)
  • proxy_use_temp_path (Optional[Enum['on', 'off']]) (defaults to: undef)
  • proxy_connect_timeout (Any) (defaults to: '90s')
  • proxy_headers_hash_bucket_size (Integer) (defaults to: 64)
  • proxy_http_version (Optional[String]) (defaults to: undef)
  • proxy_read_timeout (Any) (defaults to: '90s')
  • proxy_redirect (Any) (defaults to: undef)
  • proxy_send_timeout (Any) (defaults to: '90s')
  • proxy_set_header (Array) (defaults to: [ 'Host $host', 'X-Real-IP $remote_addr', 'X-Forwarded-For $proxy_add_x_forwarded_for', 'Proxy ""', ])
  • proxy_hide_header (Array) (defaults to: [])
  • proxy_pass_header (Array) (defaults to: [])
  • proxy_ignore_header (Array) (defaults to: [])
  • sendfile (Any) (defaults to: 'on')
  • server_tokens (String) (defaults to: 'on')
  • spdy (Any) (defaults to: 'off')
  • http2 (Any) (defaults to: 'off')
  • ssl_stapling (Any) (defaults to: 'off')
  • types_hash_bucket_size (Any) (defaults to: '512')
  • types_hash_max_size (Any) (defaults to: '1024')
  • worker_connections (Integer) (defaults to: 1024)
  • ssl_prefer_server_ciphers (Enum['on', 'off']) (defaults to: 'on')
  • worker_processes (Variant[Integer, Enum['auto']]) (defaults to: 1)
  • worker_rlimit_nofile (Integer) (defaults to: 1024)
  • ssl_protocols (Any) (defaults to: 'TLSv1 TLSv1.1 TLSv1.2')
  • ssl_ciphers (Any) (defaults to: 'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS')
  • ssl_dhparam (Optional[Stdlib::Unixpath]) (defaults to: undef)
  • package_ensure (Any) (defaults to: present)
  • package_name (Any) (defaults to: $nginx::params::package_name)
  • package_source (Any) (defaults to: 'nginx')
  • package_flavor (Any) (defaults to: undef)
  • manage_repo (Any) (defaults to: $nginx::params::manage_repo)
  • repo_release (Optional[String]) (defaults to: undef)
  • passenger_package_ensure (Any) (defaults to: 'present')
  • service_ensure (Any) (defaults to: running)
  • service_flags (Any) (defaults to: undef)
  • service_restart (Any) (defaults to: undef)
  • service_name (Any) (defaults to: 'nginx')
  • service_manage (Any) (defaults to: true)
  • geo_mappings (Any) (defaults to: {})
  • string_mappings (Any) (defaults to: {})
  • nginx_locations (Any) (defaults to: {})
  • nginx_locations_defaults (Any) (defaults to: {})
  • nginx_mailhosts (Any) (defaults to: {})
  • nginx_mailhosts_defaults (Any) (defaults to: {})
  • nginx_streamhosts (Any) (defaults to: {})
  • nginx_upstreams (Any) (defaults to: {})
  • nginx_servers (Any) (defaults to: {})
  • nginx_servers_defaults (Any) (defaults to: {})
  • purge_passenger_repo (Boolean) (defaults to: true)


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
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
# File 'manifests/init.pp', line 27

class nginx (
  ### START Nginx Configuration ###
  $client_body_temp_path                                     = $nginx::params::client_body_temp_path,
  Boolean $confd_only                                        = false,
  Boolean $confd_purge                                       = false,
  $conf_dir                                                  = $nginx::params::conf_dir,
  Optional[Enum['on', 'off']] $daemon                        = undef,
  $daemon_user                                               = $nginx::params::daemon_user,
  $daemon_group                                              = undef,
  $global_owner                                              = $nginx::params::global_owner,
  $global_group                                              = $nginx::params::global_group,
  $global_mode                                               = $nginx::params::global_mode,
  $log_dir                                                   = $nginx::params::log_dir,
  $log_group                                                 = $nginx::params::log_group,
  $log_mode                                                  = '0750',
  Variant[String, Array[String]] $http_access_log            = "${log_dir}/${::nginx::params::http_access_log_file}",
  $http_format_log                                           = undef,
  Variant[String, Array[String]] $nginx_error_log            = "${log_dir}/${::nginx::params::nginx_error_log_file}",
  Nginx::ErrorLogSeverity $nginx_error_log_severity          = 'error',
  $pid                                                       = $nginx::params::pid,
  $proxy_temp_path                                           = $nginx::params::proxy_temp_path,
  $root_group                                                = $nginx::params::root_group,
  $run_dir                                                   = $nginx::params::run_dir,
  $sites_available_owner                                     = $nginx::params::sites_available_owner,
  $sites_available_group                                     = $nginx::params::sites_available_group,
  $sites_available_mode                                      = $nginx::params::sites_available_mode,
  Boolean $super_user                                        = $nginx::params::super_user,
  $temp_dir                                                  = $nginx::params::temp_dir,
  Boolean $server_purge                                      = false,

  # Primary Templates
  $conf_template                                             = 'nginx/conf.d/nginx.conf.erb',

  ### START Nginx Configuration ###
  $accept_mutex                                              = 'on',
  $accept_mutex_delay                                        = '500ms',
  $client_body_buffer_size                                   = '128k',
  String $client_max_body_size                               = '10m',
  $client_body_timeout                                       = '60s',
  $send_timeout                                              = '60s',
  $lingering_timeout                                         = '5s',
  Optional[Enum['on', 'off']] $etag                          = undef,
  Optional[String] $events_use                               = undef,
  String $fastcgi_cache_inactive                             = '20m',
  Optional[String] $fastcgi_cache_key                        = undef,
  String $fastcgi_cache_keys_zone                            = 'd3:100m',
  String $fastcgi_cache_levels                               = '1',
  String $fastcgi_cache_max_size                             = '500m',
  Optional[String] $fastcgi_cache_path                       = undef,
  Optional[String] $fastcgi_cache_use_stale                  = undef,
  $gzip                                                      = 'on',
  $gzip_buffers                                              = undef,
  $gzip_comp_level                                           = 1,
  $gzip_disable                                              = 'msie6',
  $gzip_min_length                                           = 20,
  $gzip_http_version                                         = 1.1,
  $gzip_proxied                                              = 'off',
  $gzip_types                                                = undef,
  $gzip_vary                                                 = 'off',
  Optional[Variant[Hash, Array]] $http_cfg_prepend           = undef,
  Optional[Variant[Hash, Array]] $http_cfg_append            = undef,
  Optional[Variant[Array[String], String]] $http_raw_prepend = undef,
  Optional[Variant[Array[String], String]] $http_raw_append  = undef,
  $http_tcp_nodelay                                          = 'on',
  $http_tcp_nopush                                           = 'off',
  $keepalive_timeout                                         = '65s',
  $keepalive_requests                                        = '100',
  $log_format                                                = {},
  Boolean $mail                                              = false,
  Boolean $stream                                            = false,
  String $multi_accept                                       = 'off',
  Integer $names_hash_bucket_size                            = 64,
  Integer $names_hash_max_size                               = 512,
  $nginx_cfg_prepend                                         = false,
  String $proxy_buffers                                      = '32 4k',
  String $proxy_buffer_size                                  = '8k',
  String $proxy_cache_inactive                               = '20m',
  String $proxy_cache_keys_zone                              = 'd2:100m',
  String $proxy_cache_levels                                 = '1',
  String $proxy_cache_max_size                               = '500m',
  Optional[Variant[Hash, String]] $proxy_cache_path          = undef,
  Optional[Integer] $proxy_cache_loader_files                = undef,
  Optional[String] $proxy_cache_loader_sleep                 = undef,
  Optional[String] $proxy_cache_loader_threshold             = undef,
  Optional[Enum['on', 'off']] $proxy_use_temp_path           = undef,
  $proxy_connect_timeout                                     = '90s',
  Integer $proxy_headers_hash_bucket_size                    = 64,
  Optional[String] $proxy_http_version                       = undef,
  $proxy_read_timeout                                        = '90s',
  $proxy_redirect                                            = undef,
  $proxy_send_timeout                                        = '90s',
  Array $proxy_set_header                                    = [
    'Host $host',
    'X-Real-IP $remote_addr',
    'X-Forwarded-For $proxy_add_x_forwarded_for',
    'Proxy ""',
  ],
  Array $proxy_hide_header                                   = [],
  Array $proxy_pass_header                                   = [],
  Array $proxy_ignore_header                                 = [],
  $sendfile                                                  = 'on',
  String $server_tokens                                      = 'on',
  $spdy                                                      = 'off',
  $http2                                                     = 'off',
  $ssl_stapling                                              = 'off',
  $types_hash_bucket_size                                    = '512',
  $types_hash_max_size                                       = '1024',
  Integer $worker_connections                                = 1024,
  Enum['on', 'off'] $ssl_prefer_server_ciphers               = 'on',
  Variant[Integer, Enum['auto']] $worker_processes           = 1,
  Integer $worker_rlimit_nofile                              = 1024,
  $ssl_protocols                                             = 'TLSv1 TLSv1.1 TLSv1.2',
  $ssl_ciphers                                               = 'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS', # lint:ignore:140chars
  Optional[Stdlib::Unixpath] $ssl_dhparam                    = undef,

  ### START Package Configuration ###
  $package_ensure                                            = present,
  $package_name                                              = $nginx::params::package_name,
  $package_source                                            = 'nginx',
  $package_flavor                                            = undef,
  $manage_repo                                               = $nginx::params::manage_repo,
  Optional[String] $repo_release                             = undef,
  $passenger_package_ensure                                  = 'present',
  ### END Package Configuration ###

  ### START Service Configuation ###
  $service_ensure                                            = running,
  $service_flags                                             = undef,
  $service_restart                                           = undef,
  $service_name                                              = 'nginx',
  $service_manage                                            = true,
  ### END Service Configuration ###

  ### START Hiera Lookups ###
  $geo_mappings                                              = {},
  $string_mappings                                           = {},
  $nginx_locations                                           = {},
  $nginx_locations_defaults                                  = {},
  $nginx_mailhosts                                           = {},
  $nginx_mailhosts_defaults                                  = {},
  $nginx_streamhosts                                         = {},
  $nginx_upstreams                                           = {},
  $nginx_servers                                             = {},
  $nginx_servers_defaults                                    = {},
  Boolean $purge_passenger_repo                              = true,
  ### END Hiera Lookups ###
) inherits nginx::params {

  contain 'nginx::package'
  contain 'nginx::config'
  contain 'nginx::service'

  create_resources('nginx::resource::upstream', $nginx_upstreams)
  create_resources('nginx::resource::server', $nginx_servers, $nginx_servers_defaults)
  create_resources('nginx::resource::location', $nginx_locations, $nginx_locations_defaults)
  create_resources('nginx::resource::mailhost', $nginx_mailhosts, $nginx_mailhosts_defaults)
  create_resources('nginx::resource::streamhost', $nginx_streamhosts)
  create_resources('nginx::resource::map', $string_mappings)
  create_resources('nginx::resource::geo', $geo_mappings)

  # Allow the end user to establish relationships to the "main" class
  # and preserve the relationship to the implementation classes through
  # a transitive relationship to the composite class.
  Class['nginx::package'] -> Class['nginx::config'] ~> Class['nginx::service']
  Class['nginx::package'] ~> Class['nginx::service']
}