Skip to content

Commit 6df36df

Browse files
committed
(CAT-1308) Improving documentation for default mods override
1 parent de2aa13 commit 6df36df

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

REFERENCE.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Default value: `true`
346346

347347
##### <a name="-apache--default_mods"></a>`default_mods`
348348

349-
Data type: `Variant[Array, Boolean]`
349+
Data type: `Variant[Array[String[1]], Boolean]`
350350

351351
Determines whether to configure and enable a set of default Apache modules depending on
352352
your operating system.<br />
@@ -356,7 +356,14 @@ on your operating system, and you can declare any other modules separately using
356356
If `true`, Puppet installs additional modules, depending on the operating system and
357357
the value of the `mpm_module` parameter. Because these lists of
358358
modules can change frequently, consult the Puppet module's code for up-to-date lists.<br />
359-
If this parameter contains an array, Puppet instead enables all passed Apache modules.
359+
If this parameter contains an array, Puppet will enable all the Apache modules passed in it.
360+
Passing the values as an array of strings provides the flexibility to override the default mods and install modules defined in `$default_mods`.
361+
For example, with array of string:<br />
362+
```puppet
363+
class { 'apache':
364+
default_mods => ['cache', 'info', 'mime_magic']
365+
}
366+
```
360367

361368
Default value: `true`
362369

manifests/default_mods.pp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
#
44
# @api private
55
class apache::default_mods (
6-
Boolean $all = true,
7-
Optional[Variant[Array[String], String]] $mods = undef,
8-
Boolean $use_systemd = $apache::use_systemd,
6+
Boolean $all = true,
7+
Optional[Variant[Array[String[1]], String[1]]] $mods = undef,
8+
Boolean $use_systemd = $apache::use_systemd,
99
) {
1010
# These are modules required to run the default configuration.
1111
# They are not configurable at this time, so we just include

manifests/init.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@
459459
class apache (
460460
String $apache_name = $apache::params::apache_name,
461461
String $service_name = $apache::params::service_name,
462-
Variant[Array, Boolean] $default_mods = true,
462+
Variant[Array[String[1]], Boolean] $default_mods = true,
463463
Boolean $default_vhost = true,
464464
Optional[String] $default_charset = undef,
465465
Boolean $default_confd_files = true,

0 commit comments

Comments
 (0)