|
1 | 1 | # @summary This installs a PostgreSQL server |
2 | 2 | # |
3 | | -# @param postgres_password Sets the password for the postgres user to your specified value. By default, this setting uses the superuser account in the Postgres database, with a user called postgres and no password. |
| 3 | +# @param postgres_password |
| 4 | +# Sets the password for the postgres user to your specified value. By default, this setting uses the superuser account in the Postgres |
| 5 | +# database, with a user called postgres and no password. |
4 | 6 | # @param package_name Specifies the name of the package to use for installing the server software. |
5 | 7 | # @param package_ensure Passes a value through to the package resource when creating the server instance. |
6 | 8 | # |
|
11 | 13 | # @param service_enable Enable the PostgreSQL service |
12 | 14 | # @param service_manage Defines whether or not Puppet should manage the service. |
13 | 15 | # @param service_name Overrides the default PostgreSQL service name. |
14 | | -# @param service_restart_on_change Overrides the default behavior to restart your PostgreSQL service when a config entry has been changed that requires a service restart to become active. |
| 16 | +# @param service_restart_on_change |
| 17 | +# Overrides the default behavior to restart your PostgreSQL service when a config entry has been changed that requires a service restart |
| 18 | +# to become active. |
15 | 19 | # @param service_provider Overrides the default PostgreSQL service provider. |
16 | 20 | # @param service_reload Overrides the default reload command for your PostgreSQL service. |
17 | 21 | # @param service_status Overrides the default status check command for your PostgreSQL service. |
18 | 22 | # @param default_database Specifies the name of the default database to connect with. On most systems this is 'postgres'. |
19 | | -# @param default_connect_settings Specifies a hash of environment variables used when connecting to a remote server. Becomes the default for other defined types, such as postgresql::server::role. |
| 23 | +# @param default_connect_settings |
| 24 | +# Specifies a hash of environment variables used when connecting to a remote server. Becomes the default for other defined types, such as |
| 25 | +# postgresql::server::role. |
20 | 26 | # |
21 | 27 | # @param listen_addresses Address list on which the PostgreSQL service will listen |
22 | | -# @param port Specifies the port for the PostgreSQL server to listen on. Note: The same port number is used for all IP addresses the server listens on. Also, for Red Hat systems and early Debian systems, changing the port causes the server to come to a full stop before being able to make the change. |
| 28 | +# @param port |
| 29 | +# Specifies the port for the PostgreSQL server to listen on. |
| 30 | +# Note: The same port number is used for all IP addresses the server listens on. |
| 31 | +# Also, for Red Hat systems and early Debian systems, changing the port causes the server to come to a full stop before being able to make |
| 32 | +# the change. |
23 | 33 | # Default value: 5432. Meaning the Postgres server listens on TCP port 5432. |
24 | 34 | # |
25 | 35 | # @param ip_mask_deny_postgres_user Specifies the IP mask from which remote connections should be denied for the postgres superuser. |
26 | 36 | # Default value: '0.0.0.0/0', which denies any remote connection. |
27 | 37 | # |
28 | | -# @param ip_mask_allow_all_users Overrides PostgreSQL defaults for remote connections. By default, PostgreSQL does not allow database user accounts to connect via TCP from remote machines. If you'd like to allow this, you can override this setting. |
29 | | -# Set to '0.0.0.0/0' to allow database users to connect from any remote machine, or '192.168.0.0/1' to allow connections from any machine on your local '192.168' subnet. |
| 38 | +# @param ip_mask_allow_all_users |
| 39 | +# Overrides PostgreSQL defaults for remote connections. By default, PostgreSQL does not allow database user accounts to connect via TCP |
| 40 | +# from remote machines. If you'd like to allow this, you can override this setting. |
| 41 | +# Set to '0.0.0.0/0' to allow database users to connect from any remote machine, or '192.168.0.0/1' to allow connections from any machine |
| 42 | +# on your local '192.168' subnet. |
30 | 43 | # Default value: '127.0.0.1/32'. |
31 | 44 | # |
32 | 45 | # @param ipv4acls Lists strings for access control for connection method, users, databases, IPv4 addresses; |
|
47 | 60 | # |
48 | 61 | # @param log_line_prefix PostgreSQL log line prefix |
49 | 62 | # |
50 | | -# @param pg_hba_conf_defaults If false, disables the defaults supplied with the module for pg_hba.conf. This is useful if you disagree with the defaults and wish to override them yourself. Be sure that your changes of course align with the rest of the module, as some access is required to perform basic psql operations for example. |
| 63 | +# @param pg_hba_conf_defaults |
| 64 | +# If false, disables the defaults supplied with the module for pg_hba.conf. This is useful if you disagree with the defaults and wish to |
| 65 | +# override them yourself. Be sure that your changes of course align with the rest of the module, as some access is required to perform |
| 66 | +# basic psql operations for example. |
51 | 67 | # |
52 | 68 | # @param user Overrides the default PostgreSQL super user and owner of PostgreSQL related files in the file system. |
53 | 69 | # @param group Overrides the default postgres user group to be used for related files in the file system. |
54 | 70 | # |
55 | 71 | # @param needs_initdb Explicitly calls the initdb operation after server package is installed, and before the PostgreSQL service is started. |
56 | 72 | # |
57 | | -# @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. |
58 | | -# @param locale Sets the default database locale for all databases created with this module. On certain operating systems this is used during the template1 initialization as well, so it becomes a default outside of the module. |
59 | | -# @param data_checksums Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent. |
60 | | -# 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. |
| 73 | +# @param encoding |
| 74 | +# Sets the default encoding for all databases created with this module. On certain operating systems this is also used during the |
| 75 | +# template1 initialization, so it becomes a default outside of the module as well. |
| 76 | +# @param locale |
| 77 | +# Sets the default database locale for all databases created with this module. On certain operating systems this is used during the |
| 78 | +# template1 initialization as well, so it becomes a default outside of the module. |
| 79 | +# @param data_checksums |
| 80 | +# Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent. |
| 81 | +# Warning: This option is used during initialization by initdb, and cannot be changed later. |
| 82 | +# If set, checksums are calculated for all objects, in all databases. |
61 | 83 | # |
62 | 84 | # @param timezone Set timezone for the PostgreSQL instance |
63 | 85 | # |
|
86 | 108 | # |
87 | 109 | # @param version Deprecated. Use postgresql::globals instead. Sets PostgreSQL version |
88 | 110 | # |
89 | | -# @param extra_systemd_config Adds extra config to systemd config file, can for instance be used to add extra openfiles. This can be a multi line string |
| 111 | +# @param extra_systemd_config |
| 112 | +# Adds extra config to systemd config file, can for instance be used to add extra openfiles. This can be a multi line string |
90 | 113 | # @param auth_host auth method used by default for host authorization |
91 | 114 | # @param auth_local auth method used by default for local authorization |
92 | 115 | # @param lc_messages locale used for logging and system messages |
|
172 | 195 |
|
173 | 196 | #Deprecated |
174 | 197 | Optional[String[1]] $version = undef, |
175 | | - |
176 | 198 | ) inherits postgresql::params { |
177 | 199 | if $version != undef { |
178 | 200 | warning('Passing "version" to postgresql::server is deprecated; please use postgresql::globals instead.') |
|
0 commit comments