Skip to content

Commit 222ad83

Browse files
committed
Add blank or basic documentation to pass tests
1 parent b5b899d commit 222ad83

19 files changed

+228
-34
lines changed

REFERENCE.md

+43-34
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,26 @@
3333

3434
### Data types
3535

36-
* [`Nginx::DebugConnection`](#Nginx--DebugConnection)
37-
* [`Nginx::ErrorLogSeverity`](#Nginx--ErrorLogSeverity)
36+
* [`Nginx::DebugConnection`](#Nginx--DebugConnection): Type Alias for Nginx::DebugConnection
37+
* [`Nginx::ErrorLogSeverity`](#Nginx--ErrorLogSeverity): Type Alias for Nginx::ErrorLogSeverity
3838
* [`Nginx::GzipProxied`](#Nginx--GzipProxied): custom type for gzip_proxied
39-
* [`Nginx::LogFormat`](#Nginx--LogFormat)
39+
* [`Nginx::LogFormat`](#Nginx--LogFormat): Type Alias for Nginx::LogFormat
4040
* [`Nginx::Package_source`](#Nginx--Package_source): Where to download NGINX from There are three versions of NGINX available: * stable (`nginx` or `nginx-stable`); * mainline (`nginx-mainline`
41-
* [`Nginx::Size`](#Nginx--Size)
41+
* [`Nginx::Size`](#Nginx--Size): Type Alias for Nginx::Size
4242
* [`Nginx::StringMappings`](#Nginx--StringMappings): custom type for the `map` variable mapping
43-
* [`Nginx::Time`](#Nginx--Time)
44-
* [`Nginx::UpstreamCustomParameters`](#Nginx--UpstreamCustomParameters)
45-
* [`Nginx::UpstreamDefaults`](#Nginx--UpstreamDefaults)
46-
* [`Nginx::UpstreamLeastTime`](#Nginx--UpstreamLeastTime)
47-
* [`Nginx::UpstreamLeastTimeHttp`](#Nginx--UpstreamLeastTimeHttp)
48-
* [`Nginx::UpstreamLeastTimeStream`](#Nginx--UpstreamLeastTimeStream)
49-
* [`Nginx::UpstreamMember`](#Nginx--UpstreamMember)
50-
* [`Nginx::UpstreamMemberDefaults`](#Nginx--UpstreamMemberDefaults)
51-
* [`Nginx::UpstreamMemberServer`](#Nginx--UpstreamMemberServer)
52-
* [`Nginx::UpstreamMembers`](#Nginx--UpstreamMembers)
53-
* [`Nginx::UpstreamSticky`](#Nginx--UpstreamSticky)
54-
* [`Nginx::UpstreamStickyZone`](#Nginx--UpstreamStickyZone)
55-
* [`Nginx::UpstreamZone`](#Nginx--UpstreamZone)
43+
* [`Nginx::Time`](#Nginx--Time): Type Alias for Nginx::Time
44+
* [`Nginx::UpstreamCustomParameters`](#Nginx--UpstreamCustomParameters): Type Alias for Nginx::UpstreamCustomParameters
45+
* [`Nginx::UpstreamDefaults`](#Nginx--UpstreamDefaults): Type Alias for Nginx::UpstreamDefaults
46+
* [`Nginx::UpstreamLeastTime`](#Nginx--UpstreamLeastTime): Type Alias for Nginx::UpstreamLeastTime
47+
* [`Nginx::UpstreamLeastTimeHttp`](#Nginx--UpstreamLeastTimeHttp): Type Alias for Nginx::UpstreamLeastTimeHttp
48+
* [`Nginx::UpstreamLeastTimeStream`](#Nginx--UpstreamLeastTimeStream): Type Alias for Nginx::UpstreamLeastTimeStream
49+
* [`Nginx::UpstreamMember`](#Nginx--UpstreamMember): Type Alias for Nginx::UpstreamMember
50+
* [`Nginx::UpstreamMemberDefaults`](#Nginx--UpstreamMemberDefaults): Type Alias for Nginx::UpstreamMemberDefaults
51+
* [`Nginx::UpstreamMemberServer`](#Nginx--UpstreamMemberServer): Type Alias for Nginx::UpstreamMemberServer
52+
* [`Nginx::UpstreamMembers`](#Nginx--UpstreamMembers): Type Alias for Nginx::UpstreamMembers
53+
* [`Nginx::UpstreamSticky`](#Nginx--UpstreamSticky): Type Alias for Nginx::UpstreamSticky
54+
* [`Nginx::UpstreamStickyZone`](#Nginx--UpstreamStickyZone): Type Alias for Nginx::UpstreamStickyZone
55+
* [`Nginx::UpstreamZone`](#Nginx--UpstreamZone): Type Alias for Nginx::UpstreamZone
5656

5757
## Classes
5858

@@ -229,6 +229,7 @@ The following parameters are available in the `nginx` class:
229229
* [`mime_types_preserve_defaults`](#-nginx--mime_types_preserve_defaults)
230230
* [`repo_release`](#-nginx--repo_release)
231231
* [`passenger_package_ensure`](#-nginx--passenger_package_ensure)
232+
* [`mail_package_name`](#-nginx--mail_package_name)
232233
* [`repo_source`](#-nginx--repo_source)
233234
* [`service_ensure`](#-nginx--service_ensure)
234235
* [`service_enable`](#-nginx--service_enable)
@@ -1504,6 +1505,14 @@ Data type: `String`
15041505

15051506
Default value: `installed`
15061507

1508+
##### <a name="-nginx--mail_package_name"></a>`mail_package_name`
1509+
1510+
Data type: `Optional[String[1]]`
1511+
1512+
1513+
1514+
Default value: `$nginx::params::mail_package_name`
1515+
15071516
##### <a name="-nginx--repo_source"></a>`repo_source`
15081517

15091518
Data type: `Optional[Stdlib::HTTPUrl]`
@@ -5164,13 +5173,13 @@ Default value: `undef`
51645173

51655174
### <a name="Nginx--DebugConnection"></a>`Nginx::DebugConnection`
51665175

5167-
The Nginx::DebugConnection data type.
5176+
Type Alias for Nginx::DebugConnection
51685177

51695178
Alias of `Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']]`
51705179

51715180
### <a name="Nginx--ErrorLogSeverity"></a>`Nginx::ErrorLogSeverity`
51725181

5173-
The Nginx::ErrorLogSeverity data type.
5182+
Type Alias for Nginx::ErrorLogSeverity
51745183

51755184
Alias of `Enum['debug', 'info', 'notice', 'warn', 'error', 'crit', 'alert', 'emerg']`
51765185

@@ -5185,7 +5194,7 @@ Alias of `Enum['off', 'expired', 'no-cache', 'no-store', 'private', 'no_last_mod
51855194

51865195
### <a name="Nginx--LogFormat"></a>`Nginx::LogFormat`
51875196

5188-
The Nginx::LogFormat data type.
5197+
Type Alias for Nginx::LogFormat
51895198

51905199
Alias of
51915200

@@ -5215,7 +5224,7 @@ Alias of `Enum['nginx', 'nginx-stable', 'nginx-mainline', 'passenger']`
52155224

52165225
### <a name="Nginx--Size"></a>`Nginx::Size`
52175226

5218-
The Nginx::Size data type.
5227+
Type Alias for Nginx::Size
52195228

52205229
Alias of `Variant[Integer[0], Pattern[/\A\d+[k|K|m|M]?\z/]]`
52215230

@@ -5230,13 +5239,13 @@ Alias of `Variant[Array[Struct[{ 'key' => String[1], 'value' => String }]], Hash
52305239

52315240
### <a name="Nginx--Time"></a>`Nginx::Time`
52325241

5233-
The Nginx::Time data type.
5242+
Type Alias for Nginx::Time
52345243

52355244
Alias of `Variant[Integer[0], Pattern[/^(?!$)((\d+y *)?(\d+M *)?(\d+w *)?(\d+d *)?(\d+h *)?(\d+m *)?(\d+s *)?(\d+ms)?|\d+)$/]]`
52365245

52375246
### <a name="Nginx--UpstreamCustomParameters"></a>`Nginx::UpstreamCustomParameters`
52385247

5239-
The Nginx::UpstreamCustomParameters data type.
5248+
Type Alias for Nginx::UpstreamCustomParameters
52405249

52415250
Alias of
52425251

@@ -5267,7 +5276,7 @@ Hash[String[1], Variant[
52675276

52685277
### <a name="Nginx--UpstreamDefaults"></a>`Nginx::UpstreamDefaults`
52695278

5270-
The Nginx::UpstreamDefaults data type.
5279+
Type Alias for Nginx::UpstreamDefaults
52715280

52725281
Alias of
52735282

@@ -5296,25 +5305,25 @@ Struct[{
52965305

52975306
### <a name="Nginx--UpstreamLeastTime"></a>`Nginx::UpstreamLeastTime`
52985307

5299-
The Nginx::UpstreamLeastTime data type.
5308+
Type Alias for Nginx::UpstreamLeastTime
53005309

53015310
Alias of `Variant[Nginx::UpstreamLeastTimeHttp, Nginx::UpstreamLeastTimeStream]`
53025311

53035312
### <a name="Nginx--UpstreamLeastTimeHttp"></a>`Nginx::UpstreamLeastTimeHttp`
53045313

5305-
The Nginx::UpstreamLeastTimeHttp data type.
5314+
Type Alias for Nginx::UpstreamLeastTimeHttp
53065315

53075316
Alias of `Enum['header', 'header inflight', 'last_byte', 'last_byte inflight']`
53085317

53095318
### <a name="Nginx--UpstreamLeastTimeStream"></a>`Nginx::UpstreamLeastTimeStream`
53105319

5311-
The Nginx::UpstreamLeastTimeStream data type.
5320+
Type Alias for Nginx::UpstreamLeastTimeStream
53125321

53135322
Alias of `Enum['connect', 'connect inflight', 'first_byte', 'first_byte inflight', 'last_byte', 'last_byte inflight']`
53145323

53155324
### <a name="Nginx--UpstreamMember"></a>`Nginx::UpstreamMember`
53165325

5317-
The Nginx::UpstreamMember data type.
5326+
Type Alias for Nginx::UpstreamMember
53185327

53195328
Alias of
53205329

@@ -5340,7 +5349,7 @@ Struct[{
53405349

53415350
### <a name="Nginx--UpstreamMemberDefaults"></a>`Nginx::UpstreamMemberDefaults`
53425351

5343-
The Nginx::UpstreamMemberDefaults data type.
5352+
Type Alias for Nginx::UpstreamMemberDefaults
53445353

53455354
Alias of
53465355

@@ -5365,19 +5374,19 @@ Struct[{
53655374

53665375
### <a name="Nginx--UpstreamMemberServer"></a>`Nginx::UpstreamMemberServer`
53675376

5368-
The Nginx::UpstreamMemberServer data type.
5377+
Type Alias for Nginx::UpstreamMemberServer
53695378

53705379
Alias of `Variant[Stdlib::Host, Pattern[/^unix:\/([^\/\0]+\/*)[^:]*$/]]`
53715380

53725381
### <a name="Nginx--UpstreamMembers"></a>`Nginx::UpstreamMembers`
53735382

5374-
The Nginx::UpstreamMembers data type.
5383+
Type Alias for Nginx::UpstreamMembers
53755384

53765385
Alias of `Hash[String, Nginx::UpstreamMember]`
53775386

53785387
### <a name="Nginx--UpstreamSticky"></a>`Nginx::UpstreamSticky`
53795388

5380-
The Nginx::UpstreamSticky data type.
5389+
Type Alias for Nginx::UpstreamSticky
53815390

53825391
Alias of
53835392

@@ -5410,13 +5419,13 @@ Variant[Hash[
54105419

54115420
### <a name="Nginx--UpstreamStickyZone"></a>`Nginx::UpstreamStickyZone`
54125421

5413-
The Nginx::UpstreamStickyZone data type.
5422+
Type Alias for Nginx::UpstreamStickyZone
54145423

54155424
Alias of `Pattern[/^[-_\.A-Za-z0-9]*:\d+[k|K|m|M]$/]`
54165425

54175426
### <a name="Nginx--UpstreamZone"></a>`Nginx::UpstreamZone`
54185427

5419-
The Nginx::UpstreamZone data type.
5428+
Type Alias for Nginx::UpstreamZone
54205429

54215430
Alias of `Pattern[/^[-_\.A-Za-z0-9]* \d+[k|K|m|M]$/]`
54225431

manifests/init.pp

+168
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,174 @@
4444
# @param nginx_snippets_defaults
4545
# Can be used to define default values for the parameter `nginx_snippets`.
4646
#
47+
# @param client_body_temp_path
48+
# @param confd_only
49+
# @param confd_purge
50+
# @param conf_dir
51+
# @param daemon
52+
# @param daemon_user
53+
# @param daemon_group
54+
# @param dynamic_modules
55+
# @param global_owner
56+
# @param global_group
57+
# @param global_mode
58+
# @param limit_req_zone
59+
# @param log_dir
60+
# @param manage_log_dir
61+
# @param log_user
62+
# @param log_group
63+
# @param log_mode
64+
# @param http_access_log
65+
# @param http_format_log
66+
# @param stream_access_log
67+
# @param stream_custom_format_log
68+
# @param nginx_error_log
69+
# @param nginx_error_log_severity
70+
# @param pid
71+
# @param proxy_temp_path
72+
# @param root_group
73+
# @param sites_available_owner
74+
# @param sites_available_group
75+
# @param sites_available_mode
76+
# @param super_user
77+
# @param temp_dir
78+
# @param server_purge
79+
# @param conf_template
80+
# @param fastcgi_conf_template
81+
# @param uwsgi_params_template
82+
# @param absolute_redirect
83+
# @param accept_mutex
84+
# @param accept_mutex_delay
85+
# @param client_body_buffer_size
86+
# @param client_max_body_size
87+
# @param client_body_timeout
88+
# @param send_timeout
89+
# @param lingering_timeout
90+
# @param lingering_close
91+
# @param lingering_time
92+
# @param etag
93+
# @param events_use
94+
# @param fastcgi_cache_inactive
95+
# @param fastcgi_cache_key
96+
# @param fastcgi_cache_keys_zone
97+
# @param fastcgi_cache_levels
98+
# @param fastcgi_cache_max_size
99+
# @param fastcgi_cache_path
100+
# @param fastcgi_cache_use_stale
101+
# @param gzip
102+
# @param gzip_buffers
103+
# @param gzip_comp_level
104+
# @param gzip_disable
105+
# @param gzip_min_length
106+
# @param gzip_http_version
107+
# @param gzip_proxied
108+
# @param gzip_types
109+
# @param gzip_vary
110+
# @param gzip_static
111+
# @param http_cfg_prepend
112+
# @param http_cfg_append
113+
# @param http_raw_prepend
114+
# @param http_raw_append
115+
# @param http_tcp_nodelay
116+
# @param http_tcp_nopush
117+
# @param keepalive_timeout
118+
# @param keepalive_requests
119+
# @param log_format
120+
# @param stream_log_format
121+
# @param mail
122+
# @param map_hash_bucket_size
123+
# @param map_hash_max_size
124+
# @param mime_types_path
125+
# @param stream
126+
# @param multi_accept
127+
# @param names_hash_bucket_size
128+
# @param names_hash_max_size
129+
# @param nginx_cfg_prepend
130+
# @param proxy_buffers
131+
# @param proxy_buffer_size
132+
# @param proxy_cache_inactive
133+
# @param proxy_cache_keys_zone
134+
# @param proxy_cache_levels
135+
# @param proxy_cache_max_size
136+
# @param proxy_cache_path
137+
# @param proxy_cache_loader_files
138+
# @param proxy_cache_loader_sleep
139+
# @param proxy_cache_loader_threshold
140+
# @param proxy_use_temp_path
141+
# @param proxy_connect_timeout
142+
# @param proxy_headers_hash_bucket_size
143+
# @param proxy_http_version
144+
# @param proxy_read_timeout
145+
# @param proxy_redirect
146+
# @param proxy_send_timeout
147+
# @param proxy_set_header
148+
# @param proxy_hide_header
149+
# @param proxy_pass_header
150+
# @param proxy_ignore_header
151+
# @param proxy_max_temp_file_size
152+
# @param proxy_busy_buffers_size
153+
# @param sendfile
154+
# @param server_tokens
155+
# @param spdy
156+
# @param http2
157+
# @param ssl_stapling
158+
# @param ssl_stapling_verify
159+
# @param snippets_dir
160+
# @param manage_snippets_dir
161+
# @param types_hash_bucket_size
162+
# @param types_hash_max_size
163+
# @param worker_connections
164+
# @param ssl_prefer_server_ciphers
165+
# @param worker_processes
166+
# @param worker_rlimit_nofile
167+
# @param pcre_jit
168+
# @param ssl_protocols
169+
# @param ssl_ciphers
170+
# @param ssl_dhparam
171+
# @param ssl_ecdh_curve
172+
# @param ssl_session_cache
173+
# @param ssl_session_timeout
174+
# @param ssl_session_tickets
175+
# @param ssl_session_ticket_key
176+
# @param ssl_buffer_size
177+
# @param ssl_crl
178+
# @param ssl_stapling_file
179+
# @param ssl_stapling_responder
180+
# @param ssl_trusted_certificate
181+
# @param ssl_verify_depth
182+
# @param ssl_password_file
183+
# @param package_ensure
184+
# @param package_name
185+
# @param package_source
186+
# @param package_flavor
187+
# @param manage_repo
188+
# @param mime_types
189+
# @param mime_types_preserve_defaults
190+
# @param repo_release
191+
# @param passenger_package_ensure
192+
# @param mail_package_name
193+
# @param repo_source
194+
# @param service_ensure
195+
# @param service_enable
196+
# @param service_flags
197+
# @param service_restart
198+
# @param service_name
199+
# @param service_manage
200+
# @param geo_mappings
201+
# @param geo_mappings_defaults
202+
# @param string_mappings
203+
# @param string_mappings_defaults
204+
# @param nginx_locations
205+
# @param nginx_locations_defaults
206+
# @param nginx_mailhosts
207+
# @param nginx_mailhosts_defaults
208+
# @param nginx_servers
209+
# @param nginx_servers_defaults
210+
# @param nginx_streamhosts
211+
# @param nginx_streamhosts_defaults
212+
# @param nginx_upstreams
213+
# @param nginx_upstreams_defaults
214+
# @param purge_passenger_repo
47215
class nginx (
48216
### START Nginx Configuration ###
49217
Optional[Variant[Stdlib::Absolutepath, Tuple[Stdlib::Absolutepath, Integer, 1, 4]]] $client_body_temp_path = undef,

types/debugconnection.pp

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
# @summary Type Alias for Nginx::DebugConnection
12
type Nginx::DebugConnection = Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']]

types/errorlogseverity.pp

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
# @summary Type Alias for Nginx::ErrorLogSeverity
12
type Nginx::ErrorLogSeverity = Enum['debug','info','notice','warn','error','crit','alert','emerg']

types/logformat.pp

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# @summary Type Alias for Nginx::LogFormat
12
type Nginx::LogFormat = Variant[
23
String[1],
34
Struct[{

types/size.pp

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# @summary Type Alias for Nginx::Size
12
type Nginx::Size = Variant[
23
Integer[0],
34
Pattern[/\A\d+[k|K|m|M]?\z/],

types/time.pp

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# @summary Type Alias for Nginx::Time
12
type Nginx::Time = Variant[
23
Integer[0],
34
Pattern[/^(?!$)((\d+y *)?(\d+M *)?(\d+w *)?(\d+d *)?(\d+h *)?(\d+m *)?(\d+s *)?(\d+ms)?|\d+)$/],

0 commit comments

Comments
 (0)