Skip to content

Commit f22ad32

Browse files
author
Daniel Carabas
committed
Fix
1 parent 4bb668d commit f22ad32

File tree

2 files changed

+32
-20
lines changed

2 files changed

+32
-20
lines changed

REFERENCE.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Default value: 'present'
115115

116116
### postgresql::globals
117117

118-
Debian is currently not supported.
118+
Class for setting cross-class global overrides.
119119

120120
* **Note** Most server-specific defaults should be overridden in the postgresql::server class.
121121
This class should be used only if you are using a non-standard OS, or if you are changing elements that can only be changed here, such as version or manage_package_repo.
@@ -320,7 +320,7 @@ Default value: {}
320320

321321
Data type: `Any`
322322

323-
Disables the defaults supplied with the module for pg_hba.conf if set to false. This is useful if you want to override the defaults. Be sure that your changes align with the rest of the module, as some access is required to perform some operations, such as basic psql operations.
323+
Disables the defaults supplied with the module for pg_hba.conf if set to false.
324324

325325
Default value: `undef`
326326

@@ -329,6 +329,10 @@ Default value: `undef`
329329
Data type: `Any`
330330

331331
Overrides the default PostgreSQL data directory for the target platform.
332+
Changing the datadir after installation causes the server to come to a full stop before making the change.
333+
For Red Hat systems, the data directory must be labeled appropriately for SELinux.
334+
On Ubuntu, you must explicitly set needs_initdb = true to allow Puppet to initialize the database in the new datadir (needs_initdb defaults to true on other systems).
335+
Warning! If datadir is changed from the default, Puppet does not manage purging of the original data directory, which causes it to fail if the data directory is changed back to the original
332336

333337
Default value: `undef`
334338

@@ -408,7 +412,7 @@ Default value: `undef`
408412

409413
Data type: `Any`
410414

411-
Sets the proxy option for the official PostgreSQL yum-repositories only. This is useful if your server is behind a corporate firewall and needs to use proxy servers for outside connectivity.
415+
Sets the proxy option for the official PostgreSQL yum-repositories only.
412416

413417
Default value: `undef`
414418

@@ -432,24 +436,27 @@ Default value: `undef`
432436

433437
Data type: `Any`
434438

435-
Sets the default encoding for all databases created with this module. On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
439+
Sets the default encoding for all databases created with this module.
440+
On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
436441

437442
Default value: `undef`
438443

439444
##### `locale`
440445

441446
Data type: `Any`
442447

443-
Sets the default database locale for all databases created with this module. On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
448+
Sets the default database locale for all databases created with this module.
449+
On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
450+
On Debian, you'll need to ensure that the 'locales-all' package is installed for full functionality of PostgreSQL.
444451

445452
Default value: `undef`
446453

447454
##### `data_checksums`
448455

449456
Data type: `Any`
450457

451-
Boolean. Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent.
452-
Warning: This option is used during initialization by initdb, and cannot be changed later. If set, checksums are calculated for all objects, in all databases.
458+
Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent.
459+
Warning: This option is used during initialization by initdb, and cannot be changed later.
453460

454461
Default value: `undef`
455462

manifests/globals.pp

+18-13
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,14 @@
3333
# @param recovery_conf_path Path to your recovery.conf file.
3434
# @param default_connect_settings Default connection settings.
3535
#
36-
# @param pg_hba_conf_defaults Disables the defaults supplied with the module for pg_hba.conf if set to false. This is useful if you want to override the defaults. Be sure that your changes align with the rest of the module, as some access is required to perform some operations, such as basic psql operations.
37-
#
38-
# @param datadir Overrides the default PostgreSQL data directory for the target platform.
39-
#
40-
# @note Changing the datadir after installation causes the server to come to a full stop before making the change. For Red Hat systems, the data directory must be labeled appropriately for SELinux. On Ubuntu, you must explicitly set needs_initdb = true to allow Puppet to initialize the database in the new datadir (needs_initdb defaults to true on other systems).
41-
# @note Warning! If datadir is changed from the default, Puppet does not manage purging of the original data directory, which causes it to fail if the data directory is changed back to the original
36+
# @param pg_hba_conf_defaults Disables the defaults supplied with the module for pg_hba.conf if set to false.
37+
#
38+
# @param datadir
39+
# Overrides the default PostgreSQL data directory for the target platform.
40+
# Changing the datadir after installation causes the server to come to a full stop before making the change.
41+
# For Red Hat systems, the data directory must be labeled appropriately for SELinux.
42+
# On Ubuntu, you must explicitly set needs_initdb = true to allow Puppet to initialize the database in the new datadir (needs_initdb defaults to true on other systems).
43+
# Warning! If datadir is changed from the default, Puppet does not manage purging of the original data directory, which causes it to fail if the data directory is changed back to the original
4244
#
4345
# @param confdir Overrides the default PostgreSQL configuration directory for the target platform.
4446
# @param bindir Overrides the default PostgreSQL binaries directory for the target platform.
@@ -51,19 +53,22 @@
5153
#
5254
# @param version The version of PostgreSQL to install and manage.
5355
# @param postgis_version Defines the version of PostGIS to install, if you install PostGIS.
54-
# @param repo_proxy Sets the proxy option for the official PostgreSQL yum-repositories only. This is useful if your server is behind a corporate firewall and needs to use proxy servers for outside connectivity.
55-
# Debian is currently not supported.
56+
# @param repo_proxy Sets the proxy option for the official PostgreSQL yum-repositories only.
5657
#
5758
# @param repo_baseurl Sets the baseurl for the PostgreSQL repository. Useful if you host your own mirror of the repository.
5859
#
5960
# @param needs_initdb Explicitly calls the initdb operation after the server package is installed and before the PostgreSQL service is started.
6061
#
61-
# @param encoding Sets the default encoding for all databases created with this module. On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
62-
# @param locale Sets the default database locale for all databases created with this module. On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
63-
# @note On Debian, you'll need to ensure that the 'locales-all' package is installed for full functionality of PostgreSQL.
62+
# @param encoding
63+
# Sets the default encoding for all databases created with this module.
64+
# On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
65+
# @param locale
66+
# Sets the default database locale for all databases created with this module.
67+
# On certain operating systems, this is also used during the template1 initialization, so it becomes a default outside of the module as well.
68+
# On Debian, you'll need to ensure that the 'locales-all' package is installed for full functionality of PostgreSQL.
6469
# @param data_checksums
65-
# Boolean. Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent.
66-
# Warning: This option is used during initialization by initdb, and cannot be changed later. If set, checksums are calculated for all objects, in all databases.
70+
# Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent.
71+
# Warning: This option is used during initialization by initdb, and cannot be changed later.
6772
#
6873
# @param timezone Sets the default timezone of the postgresql server. The postgresql built-in default is taking the systems timezone information.
6974
#

0 commit comments

Comments
 (0)