Skip to content

Commit 502a891

Browse files
Ramesh7Ramesh7
authored
Merge pull request #2470 from puppetlabs/CAT-1449-deprecation-cleanup
(CAT-1449) - Remove deprecated parameters for scriptaliases & passenger
2 parents d1a79ed + 8426bcd commit 502a891

File tree

9 files changed

+22
-695
lines changed

9 files changed

+22
-695
lines changed

‎REFERENCE.md‎

Lines changed: 1 addition & 177 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ mod-pagespeed-stable package. The module does however require that the package b
7575
or be installable using the system's default package provider. You should ensure that this
7676
pre-requisite is met or declaring `apache::mod::pagespeed` will cause the puppet run to fail.
7777
* [`apache::mod::passenger`](#apache--mod--passenger): Installs `mod_pasenger`.
78+
> **Note**: This module support Passenger 4.0.0 and higher.
7879
* [`apache::mod::perl`](#apache--mod--perl): Installs `mod_perl`.
7980
* [`apache::mod::peruser`](#apache--mod--peruser): Installs `mod_peruser`.
8081
* [`apache::mod::php`](#apache--mod--php): Installs `mod_php`.
@@ -217,7 +218,6 @@ The following parameters are available in the `apache` class:
217218
* [`default_ssl_key`](#-apache--default_ssl_key)
218219
* [`default_ssl_reload_on_change`](#-apache--default_ssl_reload_on_change)
219220
* [`default_ssl_vhost`](#-apache--default_ssl_vhost)
220-
* [`default_type`](#-apache--default_type)
221221
* [`default_vhost`](#-apache--default_vhost)
222222
* [`dev_packages`](#-apache--dev_packages)
223223
* [`docroot`](#-apache--docroot)
@@ -279,7 +279,6 @@ The following parameters are available in the `apache` class:
279279
* [`limitreqfieldsize`](#-apache--limitreqfieldsize)
280280
* [`limitreqline`](#-apache--limitreqline)
281281
* [`ip`](#-apache--ip)
282-
* [`purge_vdir`](#-apache--purge_vdir)
283282
* [`conf_enabled`](#-apache--conf_enabled)
284283
* [`vhost_enable_dir`](#-apache--vhost_enable_dir)
285284
* [`manage_vhost_enable_dir`](#-apache--manage_vhost_enable_dir)
@@ -463,16 +462,6 @@ apache::vhost { 'default-ssl':
463462

464463
Default value: `false`
465464

466-
##### <a name="-apache--default_type"></a>`default_type`
467-
468-
Data type: `String`
469-
470-
_Apache 2.2 only_. Sets the MIME `content-type` sent if the server cannot otherwise
471-
determine an appropriate `content-type`. This directive is deprecated in Apache 2.4 and
472-
newer, and is only for backwards compatibility in configuration files.
473-
474-
Default value: `'none'`
475-
476465
##### <a name="-apache--default_vhost"></a>`default_vhost`
477466

478467
Data type: `Boolean`
@@ -1090,15 +1079,6 @@ Specifies the ip address
10901079

10911080
Default value: `undef`
10921081

1093-
##### <a name="-apache--purge_vdir"></a>`purge_vdir`
1094-
1095-
Data type: `Boolean`
1096-
1097-
Removes all other Apache configs and virtual hosts.<br />
1098-
> **Note**: This parameter is deprecated in favor of the `purge_configs` parameter.<br />
1099-
1100-
Default value: `false`
1101-
11021082
##### <a name="-apache--conf_enabled"></a>`conf_enabled`
11031083

11041084
Data type: `Optional[Stdlib::Absolutepath]`
@@ -4515,22 +4495,9 @@ The following parameters are available in the `apache::mod::passenger` class:
45154495
* [`passenger_use_global_queue`](#-apache--mod--passenger--passenger_use_global_queue)
45164496
* [`passenger_user`](#-apache--mod--passenger--passenger_user)
45174497
* [`passenger_user_switching`](#-apache--mod--passenger--passenger_user_switching)
4518-
* [`rack_auto_detect`](#-apache--mod--passenger--rack_auto_detect)
4519-
* [`rack_autodetect`](#-apache--mod--passenger--rack_autodetect)
4520-
* [`rack_base_uri`](#-apache--mod--passenger--rack_base_uri)
45214498
* [`rack_env`](#-apache--mod--passenger--rack_env)
4522-
* [`rails_allow_mod_rewrite`](#-apache--mod--passenger--rails_allow_mod_rewrite)
4523-
* [`rails_app_spawner_idle_time`](#-apache--mod--passenger--rails_app_spawner_idle_time)
4524-
* [`rails_auto_detect`](#-apache--mod--passenger--rails_auto_detect)
4525-
* [`rails_autodetect`](#-apache--mod--passenger--rails_autodetect)
4526-
* [`rails_base_uri`](#-apache--mod--passenger--rails_base_uri)
4527-
* [`rails_default_user`](#-apache--mod--passenger--rails_default_user)
45284499
* [`rails_env`](#-apache--mod--passenger--rails_env)
45294500
* [`rails_framework_spawner_idle_time`](#-apache--mod--passenger--rails_framework_spawner_idle_time)
4530-
* [`rails_ruby`](#-apache--mod--passenger--rails_ruby)
4531-
* [`rails_spawn_method`](#-apache--mod--passenger--rails_spawn_method)
4532-
* [`rails_user_switching`](#-apache--mod--passenger--rails_user_switching)
4533-
* [`wsgi_auto_detect`](#-apache--mod--passenger--wsgi_auto_detect)
45344501

45354502
##### <a name="-apache--mod--passenger--manage_repo"></a>`manage_repo`
45364503

@@ -5179,30 +5146,6 @@ Toggles whether to attempt to enable user account sandboxing, also known as user
51795146

51805147
Default value: `undef`
51815148

5182-
##### <a name="-apache--mod--passenger--rack_auto_detect"></a>`rack_auto_detect`
5183-
5184-
Data type: `Optional[String]`
5185-
5186-
This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.
5187-
5188-
Default value: `undef`
5189-
5190-
##### <a name="-apache--mod--passenger--rack_autodetect"></a>`rack_autodetect`
5191-
5192-
Data type: `Optional[String]`
5193-
5194-
This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.
5195-
5196-
Default value: `undef`
5197-
5198-
##### <a name="-apache--mod--passenger--rack_base_uri"></a>`rack_base_uri`
5199-
5200-
Data type: `Optional[String]`
5201-
5202-
Deprecated in 3.0.0 in favor of PassengerBaseURI.
5203-
5204-
Default value: `undef`
5205-
52065149
##### <a name="-apache--mod--passenger--rack_env"></a>`rack_env`
52075150

52085151
Data type: `Optional[String]`
@@ -5211,54 +5154,6 @@ Alias for PassengerAppEnv.
52115154

52125155
Default value: `undef`
52135156

5214-
##### <a name="-apache--mod--passenger--rails_allow_mod_rewrite"></a>`rails_allow_mod_rewrite`
5215-
5216-
Data type: `Optional[String]`
5217-
5218-
This option doesn't do anything anymore since version 4.0.0.
5219-
5220-
Default value: `undef`
5221-
5222-
##### <a name="-apache--mod--passenger--rails_app_spawner_idle_time"></a>`rails_app_spawner_idle_time`
5223-
5224-
Data type: `Optional[String]`
5225-
5226-
This option has been removed in version 4.0.0, and replaced with PassengerMaxPreloaderIdleTime.
5227-
5228-
Default value: `undef`
5229-
5230-
##### <a name="-apache--mod--passenger--rails_auto_detect"></a>`rails_auto_detect`
5231-
5232-
Data type: `Optional[String]`
5233-
5234-
This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.
5235-
5236-
Default value: `undef`
5237-
5238-
##### <a name="-apache--mod--passenger--rails_autodetect"></a>`rails_autodetect`
5239-
5240-
Data type: `Optional[String]`
5241-
5242-
This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.
5243-
5244-
Default value: `undef`
5245-
5246-
##### <a name="-apache--mod--passenger--rails_base_uri"></a>`rails_base_uri`
5247-
5248-
Data type: `Optional[String]`
5249-
5250-
Deprecated in 3.0.0 in favor of PassengerBaseURI.
5251-
5252-
Default value: `undef`
5253-
5254-
##### <a name="-apache--mod--passenger--rails_default_user"></a>`rails_default_user`
5255-
5256-
Data type: `Optional[String]`
5257-
5258-
Deprecated in 3.0.0 in favor of PassengerDefaultUser
5259-
5260-
Default value: `undef`
5261-
52625157
##### <a name="-apache--mod--passenger--rails_env"></a>`rails_env`
52635158

52645159
Data type: `Optional[String]`
@@ -5276,38 +5171,6 @@ altogether. You should use smart spawning instead.
52765171

52775172
Default value: `undef`
52785173

5279-
##### <a name="-apache--mod--passenger--rails_ruby"></a>`rails_ruby`
5280-
5281-
Data type: `Optional[String]`
5282-
5283-
Deprecated in 3.0.0 in favor of PassengerRuby.
5284-
5285-
Default value: `undef`
5286-
5287-
##### <a name="-apache--mod--passenger--rails_spawn_method"></a>`rails_spawn_method`
5288-
5289-
Data type: `Optional[String]`
5290-
5291-
Deprecated in 3.0.0 in favor of PassengerSpawnMethod.
5292-
5293-
Default value: `undef`
5294-
5295-
##### <a name="-apache--mod--passenger--rails_user_switching"></a>`rails_user_switching`
5296-
5297-
Data type: `Optional[String]`
5298-
5299-
Deprecated in 3.0.0 in favor of PassengerUserSwitching.
5300-
5301-
Default value: `undef`
5302-
5303-
##### <a name="-apache--mod--passenger--wsgi_auto_detect"></a>`wsgi_auto_detect`
5304-
5305-
Data type: `Optional[String]`
5306-
5307-
This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.
5308-
5309-
Default value: `undef`
5310-
53115174
### <a name="apache--mod--perl"></a>`apache::mod::perl`
53125175

53135176
Installs `mod_perl`.
@@ -7753,7 +7616,6 @@ The following parameters are available in the `apache::vhost` defined type:
77537616
* [`rewrite_cond`](#-apache--vhost--rewrite_cond)
77547617
* [`rewrite_inherit`](#-apache--vhost--rewrite_inherit)
77557618
* [`scriptalias`](#-apache--vhost--scriptalias)
7756-
* [`scriptaliases`](#-apache--vhost--scriptaliases)
77577619
* [`serveradmin`](#-apache--vhost--serveradmin)
77587620
* [`serveraliases`](#-apache--vhost--serveraliases)
77597621
* [`servername`](#-apache--vhost--servername)
@@ -7947,11 +7809,6 @@ a corresponding context, such as `<Directory /path/to/directory>` or
79477809
the `aliases` parameter. As described in the `mod_alias` documentation, add more specific
79487810
`alias`, `aliasmatch`, `scriptalias` or `scriptaliasmatch` parameters before the more
79497811
general ones to avoid shadowing.<BR />
7950-
> **Note**: Use the `aliases` parameter instead of the `scriptaliases` parameter because
7951-
you can precisely control the order of various alias directives. Defining `ScriptAliases`
7952-
using the `scriptaliases` parameter means *all* `ScriptAlias` directives will come after
7953-
*all* `Alias` directives, which can lead to `Alias` directives shadowing `ScriptAlias`
7954-
directives. This often causes problems; for example, this could cause problems with Nagios.<BR />
79557812
If `apache::mod::passenger` is loaded and `PassengerHighPerformance` is `true`, the `Alias`
79567813
directive might not be able to honor the `PassengerEnabled => off` statement. See
79577814
[this article](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) for details.
@@ -9761,39 +9618,6 @@ Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as
97619618

97629619
Default value: `undef`
97639620

9764-
##### <a name="-apache--vhost--scriptaliases"></a>`scriptaliases`
9765-
9766-
Data type: `Array[Hash]`
9767-
9768-
> **Note**: This parameter is deprecated in favor of the `aliases` parameter.<br />
9769-
Passes an array of hashes to the virtual host to create either ScriptAlias or
9770-
ScriptAliasMatch statements per the `mod_alias` documentation.
9771-
``` puppet
9772-
scriptaliases => [
9773-
{
9774-
alias => '/myscript',
9775-
path => '/usr/share/myscript',
9776-
},
9777-
{
9778-
aliasmatch => '^/foo(.*)',
9779-
path => '/usr/share/fooscripts$1',
9780-
},
9781-
{
9782-
aliasmatch => '^/bar/(.*)',
9783-
path => '/usr/share/bar/wrapper.sh/$1',
9784-
},
9785-
{
9786-
alias => '/neatscript',
9787-
path => '/usr/share/neatscript',
9788-
},
9789-
]
9790-
```
9791-
The ScriptAlias and ScriptAliasMatch directives are created in the order specified.
9792-
As with [Alias and AliasMatch](#aliases) directives, specify more specific aliases
9793-
before more general ones to avoid shadowing.
9794-
9795-
Default value: `[]`
9796-
97979621
##### <a name="-apache--vhost--serveradmin"></a>`serveradmin`
97989622

97999623
Data type: `Optional[String]`

‎manifests/init.pp‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,6 @@
105105
# ```
106106
# **Note**: SSL virtual hosts only respond to HTTPS queries.
107107
#
108-
# @param default_type
109-
# _Apache 2.2 only_. Sets the MIME `content-type` sent if the server cannot otherwise
110-
# determine an appropriate `content-type`. This directive is deprecated in Apache 2.4 and
111-
# newer, and is only for backwards compatibility in configuration files.
112-
#
113108
# @param default_vhost
114109
# Configures a default virtual host when the class is declared.<br />
115110
# To configure customized virtual hosts, set this parameter's
@@ -423,10 +418,6 @@
423418
#
424419
# @param ip
425420
# Specifies the ip address
426-
#
427-
# @param purge_vdir
428-
# Removes all other Apache configs and virtual hosts.<br />
429-
# > **Note**: This parameter is deprecated in favor of the `purge_configs` parameter.<br />
430421
#
431422
# @param conf_enabled
432423
# Whether the additional config files in `/etc/apache2/conf-enabled` should be managed.
@@ -472,7 +463,6 @@
472463
Optional[Stdlib::Absolutepath] $default_ssl_crl = undef,
473464
Optional[String] $default_ssl_crl_check = undef,
474465
Boolean $default_ssl_reload_on_change = false,
475-
String $default_type = 'none',
476466
Optional[Variant[Array, String]] $dev_packages = $apache::params::dev_packages,
477467
Optional[String] $ip = undef,
478468
Boolean $service_enable = true,
@@ -481,7 +471,6 @@
481471
Optional[String] $service_restart = undef,
482472
Boolean $purge_configs = true,
483473
Optional[Boolean] $purge_vhost_dir = undef,
484-
Boolean $purge_vdir = false,
485474
Optional[String[1]] $serveradmin = undef,
486475
Apache::OnOff $sendfile = 'On',
487476
Optional[Apache::OnOff] $ldap_verify_server_cert = undef,
@@ -599,17 +588,9 @@
599588
service_restart => $service_restart,
600589
}
601590

602-
# Deprecated backwards-compatibility
603-
if $purge_vdir {
604-
warning('Class[\'apache\'] parameter purge_vdir is deprecated in favor of purge_configs')
605-
$purge_confd = $purge_vdir
606-
} else {
607-
$purge_confd = $purge_configs
608-
}
609-
610591
# Set purge vhostd appropriately
611592
if $purge_vhost_dir == undef {
612-
$purge_vhostd = $purge_confd
593+
$purge_vhostd = $purge_configs
613594
} else {
614595
$purge_vhostd = $purge_vhost_dir
615596
}
@@ -627,8 +608,8 @@
627608
file { $confd_dir:
628609
ensure => directory,
629610
recurse => true,
630-
purge => $purge_confd,
631-
force => $purge_confd,
611+
purge => $purge_configs,
612+
force => $purge_configs,
632613
notify => Class['Apache::Service'],
633614
require => Package['httpd'],
634615
}
@@ -637,8 +618,8 @@
637618
file { $conf_enabled:
638619
ensure => directory,
639620
recurse => true,
640-
purge => $purge_confd,
641-
force => $purge_confd,
621+
purge => $purge_configs,
622+
force => $purge_configs,
642623
notify => Class['Apache::Service'],
643624
require => Package['httpd'],
644625
}

0 commit comments

Comments
 (0)