Skip to content

Commit 05a7809

Browse files
authored
Merge pull request #1610 from ekohl/improve-readme
Document how to select a version as its own chapter
2 parents 0c66889 + 231e008 commit 05a7809

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

README.md

+39-15
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,50 @@ If you get an error message from these commands, your permission settings restri
7474

7575
For more details about server configuration parameters, consult the [PostgreSQL Runtime Configuration documentation](http://www.postgresql.org/docs/current/static/runtime-config.html).
7676

77+
#### Selecting a version
78+
79+
The version is intended to be supplied via `postgresql::globals`.
80+
By default the module tries to derive the version based on the OS facts, but can be overridden.
81+
This is typically used with the official postgresql.org packages:
82+
83+
```puppet
84+
class { 'postgresql::globals':
85+
manage_package_repo => true,
86+
version => '16',
87+
}
88+
89+
include postgresql::server
90+
```
91+
92+
On EL 8 & 9 you can also use DNF modules:
93+
94+
```puppet
95+
class { 'postgresql::globals':
96+
manage_dnf_module => true,
97+
version => '16',
98+
}
99+
100+
include postgresql::server
101+
```
102+
103+
If you manage the repositories yourself, overriding the version is sufficient.
104+
105+
```puppet
106+
class { 'postgresql::globals':
107+
version => '16',
108+
}
109+
110+
include postgresql::server
111+
```
112+
77113
### Configure an instance
78114

79115
This module supports managing multiple instances (the default instance is referred to as 'main' and managed via including the server.pp class)
80116

81-
**NOTE:** This feature is currently tested on Centos 8 Streams/RHEL8 with DNF Modules enabled. Different Linux plattforms and/or the Postgresql.org
82-
packages distribute different Systemd service files or use wrapper scripts with Systemd to start Postgres. Additional adjustmentments are needed to get this working on these plattforms.
117+
**NOTE:** This feature is currently tested on CentOS 8 Streams/RHEL8 with DNF Modules enabled. Different Linux platforms and/or the postgresql.org
118+
packages distribute different systemd service files or use wrapper scripts with systemd to start PostgreSQL. Additional adjustmentments are needed to get this working on these platforms.
83119

84-
#### Working Plattforms
120+
#### Working Platforms
85121

86122
* Centos 8 Streams
87123
* RHEL 8
@@ -341,18 +377,6 @@ class { 'postgresql::server':
341377
}
342378
```
343379

344-
To use a specific version of the PostgreSQL package:
345-
346-
```puppet
347-
class { 'postgresql::globals':
348-
manage_package_repo => true,
349-
version => '9.2',
350-
}
351-
352-
class { 'postgresql::server':
353-
}
354-
```
355-
356380
### Manage remote users, roles, and permissions
357381

358382
Remote SQL objects are managed using the same Puppet resources as local SQL objects, along with a `$connect_settings` hash. This provides control over how Puppet connects to the remote Postgres instances and which version is used for generating SQL commands.

0 commit comments

Comments
 (0)