Skip to content

Commit ca6fb52

Browse files
committed
(CAT-1450) - Added new parameters for passenger mod
1 parent 5d47675 commit ca6fb52

File tree

5 files changed

+257
-11
lines changed

5 files changed

+257
-11
lines changed

REFERENCE.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4423,10 +4423,15 @@ The following parameters are available in the `apache::mod::passenger` class:
44234423
* [`mod_package`](#-apache--mod--passenger--mod_package)
44244424
* [`mod_package_ensure`](#-apache--mod--passenger--mod_package_ensure)
44254425
* [`mod_path`](#-apache--mod--passenger--mod_path)
4426+
* [`passenger_admin_panel_url`](#-apache--mod--passenger--passenger_admin_panel_url)
4427+
* [`passenger_admin_panel_auth_type`](#-apache--mod--passenger--passenger_admin_panel_auth_type)
4428+
* [`passenger_admin_panel_username`](#-apache--mod--passenger--passenger_admin_panel_username)
4429+
* [`passenger_admin_panel_password`](#-apache--mod--passenger--passenger_admin_panel_password)
44264430
* [`passenger_allow_encoded_slashes`](#-apache--mod--passenger--passenger_allow_encoded_slashes)
44274431
* [`passenger_anonymous_telemetry_proxy`](#-apache--mod--passenger--passenger_anonymous_telemetry_proxy)
44284432
* [`passenger_app_env`](#-apache--mod--passenger--passenger_app_env)
44294433
* [`passenger_app_group_name`](#-apache--mod--passenger--passenger_app_group_name)
4434+
* [`passenger_app_log_file`](#-apache--mod--passenger--passenger_app_log_file)
44304435
* [`passenger_app_root`](#-apache--mod--passenger--passenger_app_root)
44314436
* [`passenger_app_type`](#-apache--mod--passenger--passenger_app_type)
44324437
* [`passenger_base_uri`](#-apache--mod--passenger--passenger_base_uri)
@@ -4445,6 +4450,7 @@ The following parameters are available in the `apache::mod::passenger` class:
44454450
* [`passenger_disable_log_prefix`](#-apache--mod--passenger--passenger_disable_log_prefix)
44464451
* [`passenger_disable_security_update_check`](#-apache--mod--passenger--passenger_disable_security_update_check)
44474452
* [`passenger_enabled`](#-apache--mod--passenger--passenger_enabled)
4453+
* [`passenger_dump_config_manifest`](#-apache--mod--passenger--passenger_dump_config_manifest)
44484454
* [`passenger_error_override`](#-apache--mod--passenger--passenger_error_override)
44494455
* [`passenger_file_descriptor_log_file`](#-apache--mod--passenger--passenger_file_descriptor_log_file)
44504456
* [`passenger_fly_with`](#-apache--mod--passenger--passenger_fly_with)
@@ -4466,6 +4472,7 @@ The following parameters are available in the `apache::mod::passenger` class:
44664472
* [`passenger_max_request_queue_size`](#-apache--mod--passenger--passenger_max_request_queue_size)
44674473
* [`passenger_max_request_time`](#-apache--mod--passenger--passenger_max_request_time)
44684474
* [`passenger_max_requests`](#-apache--mod--passenger--passenger_max_requests)
4475+
* [`passenger_max_request_queue_time`](#-apache--mod--passenger--passenger_max_request_queue_time)
44694476
* [`passenger_memory_limit`](#-apache--mod--passenger--passenger_memory_limit)
44704477
* [`passenger_meteor_app_settings`](#-apache--mod--passenger--passenger_meteor_app_settings)
44714478
* [`passenger_min_instances`](#-apache--mod--passenger--passenger_min_instances)
@@ -4556,6 +4563,39 @@ Specifies a path to the module. Do not manually set this parameter without a spe
45564563

45574564
Default value: `undef`
45584565

4566+
##### <a name="-apache--mod--passenger--passenger_admin_panel_url"></a>`passenger_admin_panel_url`
4567+
4568+
Data type: `Optional[String]`
4569+
4570+
Specifies a Fuse Panel URL that the Passenger to to enable monitoring, administering, analysis and troubleshooting of this Passenger instance and apps.
4571+
4572+
Default value: `undef`
4573+
4574+
##### <a name="-apache--mod--passenger--passenger_admin_panel_auth_type"></a>`passenger_admin_panel_auth_type`
4575+
4576+
Data type: `Optional[Enum['basic']]`
4577+
4578+
Specifies the authentication type to use for the Fuse Panel. Currently it support only basic type of authentiction.
4579+
Ref : https://www.phusionpassenger.com/library/config/apache/reference/#passengeradminpanelauthtype
4580+
4581+
Default value: `undef`
4582+
4583+
##### <a name="-apache--mod--passenger--passenger_admin_panel_username"></a>`passenger_admin_panel_username`
4584+
4585+
Data type: `Optional[String]`
4586+
4587+
The username that Passenger should use when connecting to the Fuse Panel with basic authentication.
4588+
4589+
Default value: `undef`
4590+
4591+
##### <a name="-apache--mod--passenger--passenger_admin_panel_password"></a>`passenger_admin_panel_password`
4592+
4593+
Data type: `Optional[String]`
4594+
4595+
The password that Passenger should use when connecting to the Fuse Panel with basic authentication.
4596+
4597+
Default value: `undef`
4598+
45594599
##### <a name="-apache--mod--passenger--passenger_allow_encoded_slashes"></a>`passenger_allow_encoded_slashes`
45604600

45614601
Data type: `Optional[Apache::OnOff]`
@@ -4593,6 +4633,14 @@ Sets the name of the application group that the current application should belon
45934633

45944634
Default value: `undef`
45954635

4636+
##### <a name="-apache--mod--passenger--passenger_app_log_file"></a>`passenger_app_log_file`
4637+
4638+
Data type: `Optional[String]`
4639+
4640+
File path to application specifile log file. By default passenger will write all application log messages to the Passenger log file.
4641+
4642+
Default value: `undef`
4643+
45964644
##### <a name="-apache--mod--passenger--passenger_app_root"></a>`passenger_app_root`
45974645

45984646
Data type: `Optional[String]`
@@ -4739,6 +4787,14 @@ Toggles whether Passenger should be enabled for that particular context.
47394787

47404788
Default value: `undef`
47414789

4790+
##### <a name="-apache--mod--passenger--passenger_dump_config_manifest"></a>`passenger_dump_config_manifest`
4791+
4792+
Data type: `Optional[String]`
4793+
4794+
Dumps the configuration manifest to the given file.
4795+
4796+
Default value: `undef`
4797+
47424798
##### <a name="-apache--mod--passenger--passenger_error_override"></a>`passenger_error_override`
47434799

47444800
Data type: `Optional[Apache::OnOff]`
@@ -4912,6 +4968,15 @@ The maximum number of requests an application process will process.
49124968

49134969
Default value: `undef`
49144970

4971+
##### <a name="-apache--mod--passenger--passenger_max_request_queue_time"></a>`passenger_max_request_queue_time`
4972+
4973+
Data type: `Optional[Integer]`
4974+
4975+
The maximum amount of time, in seconds, that a request may be queued before Passenger will return an error.
4976+
This option specifies the maximum time a request may spend in that queue. If a request in the queue reaches this specified limit, then Passenger will send a "504 Gateway Timeout" error for that request.
4977+
4978+
Default value: `undef`
4979+
49154980
##### <a name="-apache--mod--passenger--passenger_memory_limit"></a>`passenger_memory_limit`
49164981

49174982
Data type: `Optional[Integer]`
@@ -7590,6 +7655,11 @@ The following parameters are available in the `apache::vhost` defined type:
75907655
* [`passenger_app_log_file`](#-apache--vhost--passenger_app_log_file)
75917656
* [`passenger_debugger`](#-apache--vhost--passenger_debugger)
75927657
* [`passenger_lve_min_uid`](#-apache--vhost--passenger_lve_min_uid)
7658+
* [`passenger_dump_config_manifest`](#-apache--vhost--passenger_dump_config_manifest)
7659+
* [`passenger_admin_panel_url`](#-apache--vhost--passenger_admin_panel_url)
7660+
* [`passenger_admin_panel_auth_type`](#-apache--vhost--passenger_admin_panel_auth_type)
7661+
* [`passenger_admin_panel_username`](#-apache--vhost--passenger_admin_panel_username)
7662+
* [`passenger_admin_panel_password`](#-apache--vhost--passenger_admin_panel_password)
75937663
* [`php_values`](#-apache--vhost--php_values)
75947664
* [`php_flags`](#-apache--vhost--php_flags)
75957665
* [`php_admin_values`](#-apache--vhost--php_admin_values)
@@ -9206,6 +9276,51 @@ specified value on LVE-enabled kernels.
92069276

92079277
Default value: `undef`
92089278

9279+
##### <a name="-apache--vhost--passenger_dump_config_manifest"></a>`passenger_dump_config_manifest`
9280+
9281+
Data type: `Optional[String]`
9282+
9283+
Sets [PassengerLveMinUid](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerlveminuid),
9284+
to dump the configuration manifest to a file.
9285+
9286+
Default value: `undef`
9287+
9288+
##### <a name="-apache--vhost--passenger_admin_panel_url"></a>`passenger_admin_panel_url`
9289+
9290+
Data type: `Optional[String]`
9291+
9292+
Sets [PassengerAdminPanelUrl](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeradminpanelurl),
9293+
to specify the URL of the Passenger admin panel.
9294+
9295+
Default value: `undef`
9296+
9297+
##### <a name="-apache--vhost--passenger_admin_panel_auth_type"></a>`passenger_admin_panel_auth_type`
9298+
9299+
Data type: `Optional[Enum['basic']]`
9300+
9301+
Sets [PassengerAdminPanelAuthType](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeradminpanelauthtype),
9302+
to specify the authentication type for the Passenger admin panel.
9303+
9304+
Default value: `undef`
9305+
9306+
##### <a name="-apache--vhost--passenger_admin_panel_username"></a>`passenger_admin_panel_username`
9307+
9308+
Data type: `Optional[String]`
9309+
9310+
Sets [PassengerAdminPanelUsername](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeradminpanelusername),
9311+
to specify the username for the Passenger admin panel.
9312+
9313+
Default value: `undef`
9314+
9315+
##### <a name="-apache--vhost--passenger_admin_panel_password"></a>`passenger_admin_panel_password`
9316+
9317+
Data type: `Optional[String]`
9318+
9319+
Sets [PassengerAdminPanelPassword](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeradminpanelpassword),
9320+
to specify the password for the Passenger admin panel.
9321+
9322+
Default value: `undef`
9323+
92099324
##### <a name="-apache--vhost--php_values"></a>`php_values`
92109325

92119326
Data type: `Hash`

manifests/mod/passenger.pp

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@
2424
# @param mod_path
2525
# Specifies a path to the module. Do not manually set this parameter without a special reason.
2626
#
27+
# @param passenger_admin_panel_url
28+
# Specifies a Fuse Panel URL that the Passenger to to enable monitoring, administering, analysis and troubleshooting of this Passenger instance and apps.
29+
#
30+
# @param passenger_admin_panel_auth_type
31+
# Specifies the authentication type to use for the Fuse Panel. Currently it support only basic type of authentiction.
32+
# Ref : https://www.phusionpassenger.com/library/config/apache/reference/#passengeradminpanelauthtype
33+
#
34+
# @param passenger_admin_panel_username
35+
# The username that Passenger should use when connecting to the Fuse Panel with basic authentication.
36+
#
37+
# @param passenger_admin_panel_password
38+
# The password that Passenger should use when connecting to the Fuse Panel with basic authentication.
39+
#
2740
# @param passenger_allow_encoded_slashes
2841
# Toggle whether URLs with encoded slashes (%2f) can be used (by default Apache does not support this).
2942
#
@@ -41,6 +54,9 @@
4154
# @param passenger_app_group_name
4255
# Sets the name of the application group that the current application should belong to.
4356
#
57+
# @param passenger_app_log_file
58+
# File path to application specifile log file. By default passenger will write all application log messages to the Passenger log file.
59+
#
4460
# @param passenger_app_root
4561
# Path to the application root which allows access independent from the DocumentRoot.
4662
#
@@ -97,6 +113,9 @@
97113
# @param passenger_enabled
98114
# Toggles whether Passenger should be enabled for that particular context.
99115
#
116+
# @param passenger_dump_config_manifest
117+
# Dumps the configuration manifest to the given file.
118+
#
100119
# @param passenger_error_override
101120
# Toggles whether Apache will intercept and handle responses with HTTP status codes of 400 and higher.
102121
#
@@ -165,6 +184,10 @@
165184
# @param passenger_max_requests
166185
# The maximum number of requests an application process will process.
167186
#
187+
# @param passenger_max_request_queue_time
188+
# The maximum amount of time, in seconds, that a request may be queued before Passenger will return an error.
189+
# This option specifies the maximum time a request may spend in that queue. If a request in the queue reaches this specified limit, then Passenger will send a "504 Gateway Timeout" error for that request.
190+
#
168191
# @param passenger_memory_limit
169192
# The maximum amount of memory that an application process may use, in megabytes.
170193
#
@@ -291,6 +314,12 @@
291314
Optional[String] $mod_package = undef,
292315
Optional[String] $mod_package_ensure = undef,
293316
Optional[String] $mod_path = undef,
317+
Optional[Integer] $passenger_max_request_queue_time = undef,
318+
Optional[String] $passenger_admin_panel_url = undef,
319+
Optional[Enum['basic']] $passenger_admin_panel_auth_type = undef,
320+
Optional[String] $passenger_admin_panel_username = undef,
321+
Optional[String] $passenger_admin_panel_password = undef,
322+
Optional[String] $passenger_app_log_file = undef,
294323
Optional[Apache::OnOff] $passenger_allow_encoded_slashes = undef,
295324
Optional[String] $passenger_anonymous_telemetry_proxy = undef,
296325
Optional[String] $passenger_app_env = undef,
@@ -313,6 +342,7 @@
313342
Optional[Boolean] $passenger_disable_log_prefix = undef,
314343
Optional[Apache::OnOff] $passenger_disable_security_update_check = undef,
315344
Optional[Apache::OnOff] $passenger_enabled = undef,
345+
Optional[String] $passenger_dump_config_manifest = undef,
316346
Optional[Apache::OnOff] $passenger_error_override = undef,
317347
Optional[String] $passenger_file_descriptor_log_file = undef,
318348
Optional[String] $passenger_fly_with = undef,
@@ -524,6 +554,46 @@
524554
fail("Passenger config option :: passenger_sticky_sessions_cookie_attributes is not introduced until version 6.0.5 :: ${passenger_installed_version} is the version reported")
525555
}
526556
}
557+
if $passenger_max_request_queue_time {
558+
if (versioncmp($passenger_installed_version, '5.1.12') < 0) {
559+
fail("Passenger config option :: passenger_base_uri is not introduced until version 5.1.12 :: ${passenger_installed_version} is the version reported")
560+
}
561+
}
562+
if $passenger_admin_panel_url {
563+
if (versioncmp($passenger_installed_version, '5.2.2') < 0) {
564+
fail("Passenger config option :: passenger_admin_panel_url is not introduced until version 5.2.2 :: ${passenger_installed_version} is the version reported")
565+
}
566+
}
567+
if $passenger_admin_panel_auth_type {
568+
if (versioncmp($passenger_installed_version, '5.2.2') < 0) {
569+
fail("Passenger config option :: passenger_admin_panel_auth_type is not introduced until version 5.2.2 :: ${passenger_installed_version} is the version reported")
570+
}
571+
}
572+
if $passenger_admin_panel_username {
573+
if (versioncmp($passenger_installed_version, '5.2.2') < 0) {
574+
fail("Passenger config option :: passenger_admin_panel_username is not introduced until version 5.2.2 :: ${passenger_installed_version} is the version reported")
575+
}
576+
}
577+
if $passenger_admin_panel_password {
578+
if (versioncmp($passenger_installed_version, '5.2.2') < 0) {
579+
fail("Passenger config option :: passenger_admin_panel_password is not introduced until version 5.2.2 :: ${passenger_installed_version} is the version reported")
580+
}
581+
}
582+
if $passenger_dump_config_manifest {
583+
if (versioncmp($passenger_installed_version, '5.2.2') < 0) {
584+
fail("Passenger config option :: passenger_dump_config_manifest is not introduced until version 5.2.2 :: ${passenger_installed_version} is the version reported")
585+
}
586+
}
587+
if $passenger_app_log_file {
588+
if (versioncmp($passenger_installed_version, '5.3.0') < 0) {
589+
fail("Passenger config option :: passenger_app_log_file is not introduced until version 5.3.0 :: ${passenger_installed_version} is the version reported")
590+
}
591+
}
592+
if $passenger_resist_deployment_errors {
593+
if (versioncmp($passenger_installed_version, '5.2.0') > 0) {
594+
fail('REMOVED PASSENGER OPTION :: passenger_resist_deployment_errors :: -- no message on the current passenger reference webpage -- ')
595+
}
596+
}
527597
}
528598
# Managed by the package, but declare it to avoid purging
529599
if $passenger_conf_package_file {
@@ -648,12 +718,24 @@
648718
# - $passenger_thread_count : since 4.0.0.
649719
# - $passenger_user : since 4.0.0.
650720
# - $passenger_user_switching : since 3.0.0.
721+
# - $passenger_dump_config_manifest : since 5.2.2
722+
# - $passenger_admin_panel_url : since 5.2.2
723+
# - $passenger_admin_panel_auth_type : since 5.2.2
724+
# - $passenger_admin_panel_username : since 5.2.2
725+
# - $passenger_admin_panel_password : since 5.2.2
726+
# - $passenger_app_log_file : since 5.3.0
727+
# - $passenger_max_request_queue_time : since 5.1.12
651728

652729
$parameters = {
730+
'passenger_admin_panel_url' => $passenger_admin_panel_url,
731+
'passenger_admin_panel_auth_type' => $passenger_admin_panel_auth_type,
732+
'passenger_admin_panel_username' => $passenger_admin_panel_username,
733+
'passenger_admin_panel_password' => $passenger_admin_panel_password,
653734
'passenger_allow_encoded_slashes' => $passenger_allow_encoded_slashes,
654735
'passenger_anonymous_telemetry_proxy' => $passenger_anonymous_telemetry_proxy,
655736
'passenger_app_env' => $passenger_app_env,
656737
'passenger_app_group_name' => $passenger_app_group_name,
738+
'passenger_app_log_file' => $passenger_app_log_file,
657739
'passenger_app_root' => $passenger_app_root,
658740
'passenger_app_type' => $passenger_app_type,
659741
'passenger_base_uri' => $passenger_base_uri,
@@ -681,13 +763,15 @@
681763
'passenger_load_shell_envvars' => $passenger_load_shell_envvars,
682764
'passenger_preload_bundler' => $passenger_preload_bundler,
683765
'passenger_log_file' => $passenger_log_file,
766+
'passenger_dump_config_manifest' => $passenger_dump_config_manifest,
684767
'passenger_log_level' => $passenger_log_level,
685768
'passenger_lve_min_uid' => $passenger_lve_min_uid,
686769
'passenger_max_instances' => $passenger_max_instances,
687770
'passenger_max_instances_per_app' => $passenger_max_instances_per_app,
688771
'passenger_max_pool_size' => $passenger_max_pool_size,
689772
'passenger_max_preloader_idle_time' => $passenger_max_preloader_idle_time,
690773
'passenger_max_request_queue_size' => $passenger_max_request_queue_size,
774+
'passenger_max_request_queue_time' => $passenger_max_request_queue_time,
691775
'passenger_max_request_time' => $passenger_max_request_time,
692776
'passenger_max_requests' => $passenger_max_requests,
693777
'passenger_memory_limit' => $passenger_memory_limit,

0 commit comments

Comments
 (0)