Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'simp-postgresql', '4.1.2'
Learn more about managing modules with a PuppetfileDocumentation
postgresql
NOTE: This version of Postgresql has been modified to work within the SIMP infrastructure!
Table of Contents
- Overview - What is the PostgreSQL module?
- Module Description - What does the module do?
- Setup - The basics of getting started with PostgreSQL module
- Usage - How to use the module for various tasks
- Upgrading - Guide for upgrading from older revisions of this module
- Reference - The classes, defines,functions and facts available in this module
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Disclaimer - Licensing information
- Transfer Notice - Notice of authorship change
- Contributors - List of module contributors
Overview
The PostgreSQL module allows you to easily manage postgres databases with Puppet.
Module Description
PostgreSQL is a high-performance, free, open-source relational database server. The postgresql module allows you to manage PostgreSQL packages and services on several operating systems, while also supporting basic management of PostgreSQL databases and users. The module offers support for basic management of common security settings.
Setup
What puppetlabs-PostgreSQL affects:
- package/service/configuration files for PostgreSQL
- listened-to ports
- IP and mask (optional)
Introductory Questions
The postgresql module offers many security configuration settings. Before getting started, you will want to consider:
- Do you want/need to allow remote connections?
- If yes, what about TCP connections?
- How restrictive do you want the database superuser's permissions to be?
Your answers to these questions will determine which of the module's parameters you'll want to specify values for.
###PE 3.2 supported module
PE 3.2 introduces Puppet Labs supported modules. The version of the postgresql module that ships within PE 3.2 is supported via normal Puppet Enterprise support channels. If you would like to access the supported module version, you will need to uninstall the shipped module and install the supported version from the Puppet Forge. You can do this by first running
# puppet module uninstall puppetlabs-postgresql
and then running
# puppet module install puppetlabs/postgresql
###Configuring the server
The main configuration you'll need to do will be around the postgresql::server
class. The default parameters are reasonable, but fairly restrictive regarding permissions for who can connect and from where. To manage a PostgreSQL server with sane defaults:
class { 'postgresql::server': }
For a more customized configuration:
class { 'postgresql::server':
ip_mask_deny_postgres_user => '0.0.0.0/32',
ip_mask_allow_all_users => '0.0.0.0/0',
listen_addresses => '*',
ipv4acls => ['hostssl all johndoe 192.168.0.0/24 cert'],
postgres_password => 'TPSrep0rt!',
}
Once you've completed your configuration of postgresql::server
, you can test out your settings from the command line:
$ psql -h localhost -U postgres
$ psql -h my.postgres.server -U
If you get an error message from these commands, it means that your permissions are set in a way that restricts access from where you're trying to connect. That might be a good thing or a bad thing, depending on your goals.
For more details about server configuration parameters consult the PostgreSQL Runtime Configuration docs.
Usage
###Creating a database
There are many ways to set up a postgres database using the postgresql::server::db
class. For instance, to set up a database for PuppetDB:
class { 'postgresql::server': }
postgresql::server::db { 'mydatabasename':
user => 'mydatabaseuser',
password => postgresql_password('mydatabaseuser', 'mypassword'),
}
###Managing users, roles and permissions
To manage users, roles and permissions:
class { 'postgresql::server': }
postgresql::server::role { 'marmot':
password_hash => postgresql_password('marmot', 'mypasswd'),
}
postgresql::server::database_grant { 'test1':
privilege => 'ALL',
db => 'test1',
role => 'marmot',
}
postgresql::server::table_grant { 'my_table of test2':
privilege => 'ALL',
table => 'my_table',
db => 'test2',
role => 'marmot',
}
In this example, you would grant ALL privileges on the test1 database and on the my_table
table of the test2 database to the user or group specified by dan.
At this point, you would just need to plunk these database name/username/password values into your PuppetDB config files, and you are good to go.
Upgrading
###Upgrading from 2.x to version 3
Note: if you are upgrading for 2.x, you must read this, as just about everything has changed.
Version 3 was a major rewrite to fix some internal dependency issues, and to make the new Public API more clear. As a consequence a lot of things have changed for version 3 and older revisions that we will try to outline here.
####Server specific objects now moved under postgresql::server::
namespace
To restructure server specific elements under the postgresql::server::
namespaces the following objects were renamed as such:
postgresql::database
->postgresql::server::database
postgresql::database_grant
->postgresql::server::database_grant
postgresql::db
->postgresql::server::db
postgresql::grant
->postgresql::server::grant
postgresql::pg_hba_rule
->postgresql::server::pg_hba_rule
postgresql::plperl
->postgresql::server::plperl
postgresql::contrib
->postgresql::server::contrib
postgresql::role
->postgresql::server::role
postgresql::table_grant
->postgresql::server::table_grant
postgresql::tablespace
->postgresql::server::tablespace
####New postgresql::server::config_entry
resource for managing configuration
Previously we used the file_line
resource to modify postgresql.conf
. This new revision now adds a new resource named postgresql::server::config_entry
for managing this file. For example:
postgresql::server::config_entry { 'check_function_bodies':
value => 'off',
}
If you were using file_line
for this purpose, you should change to this new methodology.
####postgresql_puppet_extras.conf
has been removed
Now that we have a methodology for managing postgresql.conf
, and due to concerns over the file management methodology using an exec { 'touch ...': }
as a way to create an empty file the existing postgresql_puppet_extras.conf file is no longer managed by this module.
If you wish to recreate this methodology yourself, use this pattern:
class { 'postgresql::server': }
$extras = "/tmp/include.conf"
file { $extras:
content => 'max_connections = 123',
notify => Class['postgresql::server::service'],
}->
postgresql::server::config_entry { 'include':
value => $extras,
}
####All uses of the parameter charset
changed to encoding
Since PostgreSQL uses the terminology encoding
not charset
the parameter has been made consisent across all classes and resources.
####The postgresql
base class is no longer how you set globals
The old global override pattern was less then optimal so it has been fixed, however we decided to demark this properly by specifying these overrides in the class postgresql::globals
. Consult the documentation for this class now to see what options are available.
Also, some parameter elements have been moved between this and the postgresql::server
class where it made sense.
####config_hash
parameter collapsed for the postgresql::server
class
Because the config_hash
was really passing data through to what was in effect an internal class (postgresql::config
). And since we don't want this kind of internal exposure the parameters were collapsed up into the postgresql::server
class directly.
####Lots of changes to 'private' or 'undocumented' classes
If you were using these before, these have changed names. You should only use what is documented in this README.md, and if you don't have what you need you should raise a patch to add that feature to a public API. All internal classes now have a comment at the top indicating them as private to make sure the message is clear that they are not supported as Public API.
####pg_hba_conf_defaults
parameter included to turn off default pg_hba rules
The defaults should be good enough for most cases (if not raise a bug) but if you simply need an escape hatch, this setting will turn off the defaults. If you want to do this, it may affect the rest of the module so make sure you replace the rules with something that continues operation.
####postgresql::database_user
has now been removed
Use postgresql::server::role
instead.
####postgresql::psql
resource has now been removed
Use postgresql_psql
instead. In the future we may recreate this as a wrapper to add extra capability, but it will not match the old behaviour.
####postgresql_default_version
fact has now been removed
It didn't make sense to have this logic in a fact any more, the logic has been moved into postgresql::params
.
####ripienaar/concat
is no longer used, instead we use puppetlabs/concat
The older concat module is now deprecated and moved into the puppetlabs/concat
namespace. Functionality is more or less identical, but you may need to intervene during the installing of this package - as both use the same concat
namespace.
Reference
The postgresql module comes with many options for configuring the server. While you are unlikely to use all of the below settings, they allow you a decent amount of control over your security settings.
Classes:
- postgresql::client
- postgresql::globals
- postgresql::lib::devel
- postgresql::lib::java
- postgresql::lib::perl
- postgresql::lib::python
- postgresql::server
- postgresql::server::plperl
- postgresql::server::contrib
- postgresql::server::postgis
Resources:
- postgresql::server::config_entry
- postgresql::server::db
- postgresql::server::database
- postgresql::server::database_grant
- postgresql::server::pg_hba_rule
- postgresql::server::pg_ident_rule
- postgresql::server::role
- postgresql::server::schema
- postgresql::server::table_grant
- postgresql::server::tablespace
- postgresql::validate_db_connection
Functions:
###Class: postgresql::globals
Note: most server specific defaults should be overriden in the postgresql::server
class. This class should only be used if you are using a non-standard OS or if you are changing elements such as version
or manage_package_repo
that can only be changed here.
This class allows you to configure the main settings for this module in a global way, to be used by the other classes and defined resources. On its own it does nothing.
For example, if you wanted to overwrite the default locale
and encoding
for all classes you could use the following combination:
class { 'postgresql::globals':
encoding => 'UTF8',
locale => 'en_NG',
}->
class { 'postgresql::server':
}
That would make the encoding
and locale
the default for all classes and defined resources in this module.
If you want to use the upstream PostgreSQL packaging, and be specific about the version you wish to download, you could use something like this:
class { 'postgresql::globals':
manage_package_repo => true,
version => '9.2',
}->
class { 'postgresql::server': }
####client_package_name
This setting can be used to override the default postgresql client package name. If not specified, the module will use whatever package name is the default for your OS distro.
####server_package_name
This setting can be used to override the default postgresql server package name. If not specified, the module will use whatever package name is the default for your OS distro.
####contrib_package_name
This setting can be used to override the default postgresql contrib package name. If not specified, the module will use whatever package name is the default for your OS distro.
####devel_package_name
This setting can be used to override the default postgresql devel package name. If not specified, the module will use whatever package name is the default for your OS distro.
####java_package_name
This setting can be used to override the default postgresql java package name. If not specified, the module will use whatever package name is the default for your OS distro.
####perl_package_name
This setting can be used to override the default postgresql Perl package name. If not specified, the module will use whatever package name is the default for your OS distro.
####plperl_package_name
This setting can be used to override the default postgresql PL/perl package name. If not specified, the module will use whatever package name is the default for your OS distro.
####python_package_name
This setting can be used to override the default postgresql Python package name. If not specified, the module will use whatever package name is the default for your OS distro.
####service_ensure
This setting can be used to override the default postgresql service ensure status. If not specified, the module will use ensure
instead.
####service_name
This setting can be used to override the default postgresql service name. If not specified, the module will use whatever service name is the default for your OS distro.
####service_provider
This setting can be used to override the default postgresql service provider. If not specified, the module will use whatever service provider is the default for your OS distro.
####service_status
This setting can be used to override the default status check command for your PostgreSQL service. If not specified, the module will use whatever service status is the default for your OS distro.
####default_database
This setting is used to specify the name of the default database to connect with. On most systems this will be "postgres".
####initdb_path
Path to the initdb
command.
####createdb_path
Path to the createdb
command.
####psql_path
Path to the psql
command.
####pg_hba_conf_path
Path to your pg\_hba.conf
file.
####pg_ident_conf_path
Path to your pg\_ident.conf
file.
####postgresql_conf_path
Path to your postgresql.conf
file.
####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.
####datadir
This setting can be used to override the default postgresql data directory for the target platform. If not specified, the module will use whatever directory is the default for your OS distro. Please note that changing the datadir after installation will cause the server to come to a full stop before being able to make the change. For RedHat systems, the data directory must be labeled appropriately for SELinux. On Ubuntu, you need to explicitly set needs_initdb to true in order to allow Puppet to initialize the database in the new datadir (needs_initdb defaults to true on other systems).
Warning: If datadir is changed from the default, puppet will not manage purging of the original data directory, which will cause it to fail if the data directory is changed back to the original.
####confdir
This setting can be used to override the default postgresql configuration directory for the target platform. If not specified, the module will use whatever directory is the default for your OS distro.
####bindir
This setting can be used to override the default postgresql binaries directory for the target platform. If not specified, the module will use whatever directory is the default for your OS distro.
####xlogdir
This setting can be used to override the default postgresql xlog directory. If not specified the module will use initdb's default path.
####user
This setting can be used to override the default postgresql super user and owner of postgresql related files in the file system. If not specified, the module will use the user name 'postgres'.
####group
This setting can be used to override the default postgresql user group to be used for related files in the file system. If not specified, the module will use the group name 'postgres'.
####version
The version of PostgreSQL to install/manage. This is a simple way of providing a specific version such as '9.2' or '8.4' for example.
Defaults to your operating system default.
####postgis_version
The version of PostGIS to install if you install PostGIS. Defaults to the lowest available with the version of PostgreSQL to be installed.
####needs_initdb
This setting can be used to explicitly call the initdb operation after server package is installed and before the postgresql service is started. If not specified, the module will decide whether to call initdb or not depending on your OS distro.
####encoding
This will set the default encoding encoding for all databases created with this module. On certain operating systems this will be used during the template1
initialization as well so it becomes a default outside of the module as well. Defaults to the operating system default.
####locale
This will set the default database locale for all databases created with this module. On certain operating systems this will be used during the template1
initialization as well so it becomes a default outside of the module as well. Defaults to undef
which is effectively C
.
#####Debian
On Debian you'll need to ensure that the 'locales-all' package is installed for full functionality of Postgres.
####manage_package_repo
If true
this will setup the official PostgreSQL repositories on your host. Defaults to false
.
###Class: postgresql::server
The following list are options that you can set in the config_hash
parameter of postgresql::server
.
####postgres_password
This value defaults to undef
, meaning the super user account in the postgres database is a user called postgres
and this account does not have a password. If you provide this setting, the module will set the password for the postgres
user to your specified value.
####package_name
The name of the package to use for installing the server software. Defaults to the default for your OS distro.
####package_ensure
Value to pass through to the package
resource when creating the server instance. Defaults to undef
.
####plperl_package_name
This sets the default package name for the PL/Perl extension. Defaults to utilising the operating system default.
####service_name
This setting can be used to override the default postgresql service name. If not specified, the module will use whatever service name is the default for your OS distro.
####service_provider
This setting can be used to override the default postgresql service provider. If not specified, the module will use whatever service name is the default for your OS distro.
####service_status
This setting can be used to override the default status check command for your PostgreSQL service. If not specified, the module will use whatever service name is the default for your OS distro.
####default_database
This setting is used to specify the name of the default database to connect with. On most systems this will be "postgres".
####listen_addresses
This value defaults to localhost
, meaning the postgres server will only accept connections from localhost. If you'd like to be able to connect to postgres from remote machines, you can override this setting. A value of *
will tell postgres to accept connections from any remote machine. Alternately, you can specify a comma-separated list of hostnames or IP addresses. (For more info, have a look at the postgresql.conf
file from your system's postgres package).
####port
This value defaults to 5432
, meaning the postgres server will listen on TCP port 5432. Note that the same port number is used for all IP addresses the server listens on. Also note that for RedHat systems and early Debian systems, changing the port will cause the server to come to a full stop before being able to make the change.
####ip_mask_deny_postgres_user
This value defaults to 0.0.0.0/0
. Sometimes it can be useful to block the superuser account from remote connections if you are allowing other database users to connect remotely. Set this to an IP and mask for which you want to deny connections by the postgres superuser account. So, e.g., the default value of 0.0.0.0/0
will match any remote IP and deny access, so the postgres user won't be able to connect remotely at all. Conversely, a value of 0.0.0.0/32
would not match any remote IP, and thus the deny rule will not be applied and the postgres user will be allowed to connect.
####ip_mask_allow_all_users
This value defaults to 127.0.0.1/32
. By default, Postgres does not allow any database user accounts to connect via TCP from remote machines. If you'd like to allow them to, you can override this setting. You might set it to 0.0.0.0/0
to allow database users to connect from any remote machine, or 192.168.0.0/16
to allow connections from any machine on your local 192.168 subnet.
####ipv4acls
List of strings for access control for connection method, users, databases, IPv4 addresses; see postgresql documentation about pg_hba.conf
for information (please note that the link will take you to documentation for the most recent version of Postgres, however links for earlier versions can be found on that page).
####ipv6acls
List of strings for access control for connection method, users, databases, IPv6 addresses; see postgresql documentation about pg_hba.conf
for information (please note that the link will take you to documentation for the most recent version of Postgres, however links for earlier versions can be found on that page).
####initdb_path
Path to the initdb
command.
####createdb_path
Path to the createdb
command.
####psql_path
Path to the psql
command.
####pg_hba_conf_path
Path to your pg\_hba.conf
file.
####pg_ident_conf_path
Path to your pg\_ident.conf
file.
####postgresql_conf_path
Path to your postgresql.conf
file.
####pg_hba_conf_defaults
If false, disables the defaults supplied with the module for pg\_hba.conf
. This is useful if you di
sagree with the defaults and wish to override them yourself. Be sure that your changes of course alig
n with the rest of the module, as some access is required to perform basic psql
operations for exam
ple.
####user
This setting can be used to override the default postgresql super user and owner of postgresql related files in the file system. If not specified, the module will use the user name 'postgres'.
####group
This setting can be used to override the default postgresql user group to be used for related files in the file system. If not specified, the module will use the group name 'postgres'.
####needs_initdb
This setting can be used to explicitly call the initdb operation after server package is installed and before the postgresql service is started. If not specified, the module will decide whether to call initdb or not depending on your OS distro.
####encoding
This will set the default encoding encoding for all databases created with this module. On certain operating systems this will be used during the template1
initialization as well so it becomes a default outside of the module as well. Defaults to the operating system default.
####locale
This will set the default database locale for all databases created with this module. On certain operating systems this will be used during the template1
initialization as well so it becomes a default outside of the module as well. Defaults to undef
which is effectively C
.
#####Debian
On Debian you'll need to ensure that the 'locales-all' package is installed for full functionality of Postgres.
####manage_pg_hba_conf
This value defaults to true
. Whether or not manage the pg_hba.conf. If set to true
, puppet will overwrite this file. If set to false
, puppet will not modify the file.
####manage_pg_ident_conf
This value defaults to true
. Whether or not manage the pg_ident.conf. If set to true
, puppet will overwrite this file. If set to false
, puppet will not modify the file.
###Class: postgresql::client
This class installs postgresql client software. Alter the following parameters if you have a custom version you would like to install (Note: don't forget to make sure to add any necessary yum or apt repositories if specifying a custom version):
####package_name
The name of the postgresql client package.
####package_ensure
The ensure parameter passed on to postgresql client package resource.
###Class: postgresql::server::contrib Installs the postgresql contrib package.
####package_name
The name of the postgresql contrib package.
####package_ensure
The ensure parameter passed on to postgresql contrib package resource.
###Class: postgresql::server::postgis Installs the postgresql postgis packages.
###Class: postgresql::lib::devel
Installs the packages containing the development libraries for PostgreSQL and
symlinks pg_config into /usr/bin
(if not in /usr/bin
or /usr/local/bin
).
####package_ensure
Override for the ensure
parameter during package installation. Defaults to present
.
####package_name
Overrides the default package name for the distribution you are installing to. Defaults to postgresql-devel
or postgresql<version>-devel
depending on your distro.
####link_pg_config
By default, if the bin directory used by the PostgreSQL package is not /usr/bin
or /usr/local/bin
,
this class will symlink pg_config
from the package's bin dir into /usr/bin
. Set link_pg_config
to
false to disable this behavior.
###Class: postgresql::lib::java This class installs postgresql bindings for Java (JDBC). Alter the following parameters if you have a custom version you would like to install (Note: don't forget to make sure to add any necessary yum or apt repositories if specifying a custom version):
####package_name
The name of the postgresql java package.
####package_ensure
The ensure parameter passed on to postgresql java package resource.
###Class: postgresql::lib::perl This class installs the postgresql Perl libraries. For customer requirements you can customise the following parameters:
####package_name
The name of the postgresql perl package.
####package_ensure
The ensure parameter passed on to postgresql perl package resource.
###Class: postgresql::lib::python This class installs the postgresql Python libraries. For customer requirements you can customise the following parameters:
####package_name
The name of the postgresql python package.
####package_ensure
The ensure parameter passed on to postgresql python package resource.
###Class: postgresql::server::plperl This class installs the PL/Perl procedural language for postgresql.
####package_name
The name of the postgresql PL/Perl package.
####package_ensure
The ensure parameter passed on to postgresql PL/Perl package resource.
###Resource: postgresql::server::config_entry
This resource can be used to modify your postgresql.conf
configuration file.
Each resource maps to a line inside your postgresql.conf
file, for example:
postgresql::server::config_entry { 'check_function_bodies':
value => 'off',
}
####namevar
Name of the setting to change.
####ensure
Set to absent
to remove an entry.
####value
Value for the setting.
###Resource: postgresql::server::db This is a convenience resource that creates a database, user and assigns necessary permissions in one go.
For example, to create a database called test1
with a corresponding user of the same name, you can use:
postgresql::server::db { 'test1':
user => 'test1',
password => 'test1',
}
####namevar
The namevar for the resource designates the name of the database.
####dbname
The name of the database to be created. Defaults to namevar
.
####owner
Name of the database user who should be set as the owner of the database. Defaults to the $user variable set in postgresql::server
or postgresql::globals
.
####user
User to create and assign access to the database upon creation. Mandatory.
####password
Password for the created user. Mandatory.
####encoding
Override the character set during creation of the database. Defaults to the default defined during installation.
####locale
Override the locale during creation of the database. Defaults to the default defined during installation.
####grant
Grant permissions during creation. Defaults to ALL
.
####tablespace
The name of the tablespace to allocate this database to. If not specifies, it defaults to the PostgreSQL default.
####template
The name of the template database from which to build this database. Defaults to template0
.
####istemplate
Define database as a template. Defaults to false
.
###Resource: postgresql::server::database This defined type can be used to create a database with no users and no permissions, which is a rare use case.
####namevar
The name of the database to create.
####dbname
The name of the database, defaults to the namevar.
####owner
Name of the database user who should be set as the owner of the database. Defaults to the $user variable set in postgresql::server
or postgresql::globals
.
####tablespace
Tablespace for where to create this database. Defaults to the defaults defined during PostgreSQL installation.
####template
The name of the template database from which to build this database. Defaults to template0
.
####encoding
Override the character set during creation of the database. Defaults to the default defined during installation.
####locale
Override the locale during creation of the database. Defaults to the default defined during installation.
####istemplate
Define database as a template. Defaults to false
.
###Resource: postgresql::server::database_grant
This defined type manages grant based access privileges for users, wrapping the postgresql::server::database_grant
for database specific permissions. Consult the PostgreSQL documentation for grant
for more information.
####namevar
Used to uniquely identify this resource, but functionality not used during grant.
####privilege
Can be one of SELECT
, TEMPORARY
, TEMP
, CONNECT
. ALL
is used as a synonym for CREATE
. If you need to add multiple privileges, a space delimited string can be used.
####db
Database to grant access to.
####role
Role or user whom you are granting access for.
####psql_db
Database to execute the grant against. This should not ordinarily be changed from the default, which is postgres
.
####psql_user
OS user for running psql
. Defaults to the default user for the module, usually postgres
.
###Resource: postgresql::server::pg_hba_rule
This defined type allows you to create an access rule for pg_hba.conf
. For more details see the PostgreSQL documentation.
For example:
postgresql::server::pg_hba_rule { 'allow application network to access app database':
description => "Open up postgresql for access from 200.1.2.0/24",
type => 'host',
database => 'app',
user => 'app',
address => '200.1.2.0/24',
auth_method => 'md5',
}
This would create a ruleset in pg_hba.conf
similar to:
# Rule Name: allow application network to access app database
# Description: Open up postgresql for access from 200.1.2.0/24
# Order: 150
host app app 200.1.2.0/24 md5
####namevar
A unique identifier or short description for this rule. The namevar doesn't provide any functional usage, but it is stored in the comments of the produced pg_hba.conf
so the originating resource can be identified.
####description
A longer description for this rule if required. Defaults to none
. This description is placed in the comments above the rule in pg_hba.conf
.
####type
The type of rule, this is usually one of: local
, host
, hostssl
or hostnossl
.
####database
A comma separated list of databases that this rule matches.
####user
A comma separated list of database users that this rule matches.
####address
If the type is not 'local' you can provide a CIDR based address here for rule matching.
####auth_method
The auth_method
is described further in the pg_hba.conf
documentation, but it provides the method that is used for authentication for the connection that this rule matches.
####auth_option
For certain auth_method
settings there are extra options that can be passed. Consult the PostgreSQL pg_hba.conf
documentation for further details.
####order
An order for placing the rule in pg_hba.conf
. Defaults to 150
.
####target
This provides the target for the rule, and is generally an internal only property. Use with caution.
###Resource: postgresql::server::pg_ident_rule
This defined type allows you to create user name maps for pg_ident.conf
. For more details see the PostgreSQL documentation.
For example:
postgresql::server::pg_ident_rule{ 'Map the SSL certificate of the backup server as a replication user':
map_name => 'sslrepli',
system_username => 'repli1.example.com',
database_username => 'replication',
}
This would create a user name map in pg_ident.conf
similar to:
# Rule Name: Map the SSL certificate of the backup server as a replication user
# Description: none
# Order: 150
sslrepli repli1.example.com replication
####namevar
A unique identifier or short description for this rule. The namevar doesn't provide any functional usage, but it is stored in the comments of the produced pg_ident.conf
so the originating resource can be identified.
####description
A longer description for this rule if required. Defaults to none
. This description is placed in the comments above the rule in pg_ident.conf
.
####map_name
Name of the user map, that is used to refer to this mapping in pg_hba.conf
.
####system_username
Operating system user name, the user name used to connect to the database.
####database_username
Database user name, the user name of the the database user. The system_username
will be mapped to this user name.
####order
An order for placing the mapping in pg_ident.conf. Defaults to 150.
####target
This provides the target for the rule, and is generally an internal only property. Use with caution.
###Resource: postgresql::server::role This resource creates a role or user in PostgreSQL.
####namevar
The role name to create.
####password_hash
The hash to use during password creation. If the password is not already pre-encrypted in a format that PostgreSQL supports, use the postgresql_password
function to provide an MD5 hash here, for example:
postgresql::role { "myusername":
password_hash => postgresql_password('myusername', 'mypassword'),
}
####createdb
Whether to grant the ability to create new databases with this role. Defaults to false
.
####createrole
Whether to grant the ability to create new roles with this role. Defaults to false
.
####login
Whether to grant login capability for the new role. Defaults to true
.
####inherit
Whether to grant inherit capability for the new role. Defaults to true
.
####superuser
Whether to grant super user capability for the new role. Defaults to false
.
####replication
If true
provides replication capabilities for this role. Defaults to false
.
####connection_limit
Specifies how many concurrent connections the role can make. Defaults to -1
meaning no limit.
####username
The username of the role to create, defaults to namevar
.
###Resource: postgresql::server::schema This defined type can be used to create a schema. For example:
postgresql::server::schema { 'isolated':
owner => 'jane',
db => 'janedb',
}
It will create the schema isolated
in the database janedb
if neccessary,
assigning the user jane
ownership permissions.
####namevar
The schema name to create.
###db
Name of the database in which to create this schema. This must be passed.
####owner
The default owner of the schema.
####schema
Name of the schma. Defaults to namevar
.
###Resource: postgresql::server::table_grant
This defined type manages grant based access privileges for users. Consult the PostgreSQL documentation for grant
for more information.
####namevar
Used to uniquely identify this resource, but functionality not used during grant.
####privilege
Can be one of SELECT
, INSERT
, UPDATE
, REFERENCES
. ALL
is used as a synonym for CREATE
. If you need to add multiple privileges, a space delimited string can be used.
####table
Table to grant access on.
####db
Database of table.
####role
Role or user whom you are granting access for.
####psql_db
Database to execute the grant against. This should not ordinarily be changed from the default, which is postgres
.
####psql_user
OS user for running psql
. Defaults to the default user for the module, usually postgres
.
###Resource: postgresql::server::tablespace This defined type can be used to create a tablespace. For example:
postgresql::server::tablespace { 'tablespace1':
location => '/srv/space1',
}
It will create the location if necessary, assigning it the same permissions as your PostgreSQL server.
####namevar
The tablespace name to create.
####location
The path to locate this tablespace.
####owner
The default owner of the tablespace.
####spcname
Name of the tablespace. Defaults to namevar
.
###Resource: postgresql::validate_db_connection This resource can be utilised inside composite manifests to validate that a client has a valid connection with a remote PostgreSQL database. It can be ran from any node where the PostgreSQL client software is installed to validate connectivity before commencing other dependent tasks in your Puppet manifests, so it is often used when chained to other tasks such as: starting an application server, performing a database migration.
Example usage:
postgresql::validate_db_connection { 'validate my postgres connection':
database_host => 'my.postgres.host',
database_username => 'mydbuser',
database_password => 'mydbpassword',
database_name => 'mydbname',
}->
exec { 'rake db:migrate':
cwd => '/opt/myrubyapp',
}
####namevar
Uniquely identify this resource, but functionally does nothing.
####database_host
The hostname of the database you wish to test. Defaults to 'undef' which generally uses the designated local unix socket.
####database_port
Port to use when connecting. Default to 'undef' which generally defaults to 5432 depending on your PostgreSQL packaging.
####database_name
The name of the database you wish to test. Defaults to 'postgres'.
####database_username
Username to connect with. Defaults to 'undef', which when using a unix socket and ident auth will be the user you are running as. If the host is remote you must provide a username.
####database_password
Password to connect with. Can be left blank, but that is not recommended.
####run_as
The user to run the psql
command with for authenticiation. This is important when trying to connect to a database locally using Unix sockets and ident
authentication. It is not needed for remote testing.
####sleep
Upon failure, sets the number of seconds to sleep for before trying again.
####tries
Upon failure, sets the number of attempts before giving up and failing the resource.
####create_db_first
This will ensure the database is created before running the test. This only really works if your test is local. Defaults to true
.
###Function: postgresql_password
If you need to generate a postgres encrypted password, use postgresql_password
. You can call it from your production manifests if you don't mind them containing the clear text versions of your passwords, or you can call it from the command line and then copy and paste the encrypted password into your manifest:
$ puppet apply --execute 'notify { "test": message => postgresql_password("username", "password") }'
###Function: postgresql_acls_to_resources_hash(acl_array, id, order_offset)
This internal function converts a list of pg_hba.conf
based acls (passed in as an array of strings) to a format compatible with the postgresql::pg_hba_rule
resource.
This function should only be used internally by the module.
Limitations
Works with versions of PostgreSQL from 8.1 through 9.2.
Current it is only actively tested with the following operating systems:
- Debian 6.x and 7.x
- Centos 5.x, 6.x, and 7.x.
- Ubuntu 10.04 and 12.04, 14.04
Although patches are welcome for making it work with other OS distros, it is considered best effort.
Postgis support
Postgis is currently considered an unsupported feature as it doesn't work on all platforms correctly.
All versions of RHEL/Centos
If you have selinux enabled you must add any custom ports you use to the postgresql_port_t context. You can do this as follows:
# semanage port -a -t postgresql_port_t -p tcp $customport
Development
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
You can read the complete module contribution guide on the Puppet Labs wiki.
Tests
There are two types of tests distributed with the module. Unit tests with rspec-puppet and system tests using rspec-system.
For unit testing, make sure you have:
- rake
- bundler
Install the necessary gems:
bundle install --path=vendor
And then run the unit tests:
bundle exec rake spec
The unit tests are ran in Travis-CI as well, if you want to see the results of your own tests register the service hook through Travis-CI via the accounts section for your Github clone of this project.
If you want to run the system tests, make sure you also have:
- vagrant > 1.2.x
- Virtualbox > 4.2.10
Then run the tests using:
bundle exec rspec spec/acceptance
To run the tests on different operating systems, see the sets available in .nodeset.yml and run the specific set with the following syntax:
RSPEC_SET=debian-607-x64 bundle exec rspec spec/acceptance
Transfer Notice
This Puppet module was originally authored by Inkling Systems. The maintainer preferred that Puppet Labs take ownership of the module for future improvement and maintenance as Puppet Labs is using it in the PuppetDB module. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Inkling.
Previously: https://github.com/inkling/puppet-postgresql
Contributors
- Andrew Moon
- Kenn Knowles (@kennknowles)
- Adrien Thebo
- Albert Koch
- Andreas Ntaflos
- Bret Comnes
- Brett Porter
- Chris Price
- dharwood
- Etienne Pelletier
- Florin Broasca
- Henrik
- Hunter Haugen
- Jari Bakken
- Jordi Boggiano
- Ken Barber
- nzakaria
- Richard Arends
- Spenser Gilliland
- stormcrow
- William Van Hevelingen
Types in this module release
##2014-11-04 - Supported Release 4.1.0 ###Summary
This release adds the ability to change the PGDATA directory, and also includes documentation and test updates, future parser support, and a few other new features.
####Features
- Future parser support
- Documentation updates
- Test updates
- Add a link from
/etc/sysconfig/pgsql/postgresql-${version}
to/etc/sysconfig/pgsql/postgresql
to support init scripts from the postgresql.org repo - Add support for changing the PGDATA directory
- Set default versions for Fedora 21 and FreeBSD
##2014-09-03 - Supported Release 4.0.0 ###Summary
This release removes the uninstall ability from the module, removes the firewall management, overhauls all of the acceptance testing, as well as adds better support for SuSE and Fedora.
###Backwards Incompatible changes.
- Uninstall code removal.
- Firewall management for Postgres.
- Set manage_pg_ident_conf to true.
####Uninstallation removal
We rely heavily on the ability to uninstall and reinstall postgres throughout our testing code, testing features like "can I move from the distribution packages to the upstream packages through the module" and over time we've learnt that the uninstall code simply doesn't work a lot of the time. It leaves traces of postgres behind or fails to remove certain packages on Ubuntu, and generally causes bits to be left on your system that you didn't expect.
When we then reinstall things fail because it's not a true clean slate, and this causes us enormous problems during test. We've spent weeks and months working on these tests and they simply don't hold up well across the full range of PE platforms.
Due to all these problems we've decided to take a stance on uninstalling in general. We feel that in 2014 it's completely reasonable and normal to have a good provisioning pipeline combined with your configuration management and the "correct" way to uninstall a fully installed service like postgresql is to simply reprovision the server without it in the first place. As a general rule this is how I personally like to work and I think is a good practice.
####I'm not OK with this!
We understand that there are environments and situations in which it's not easy to do that. What if you accidently deployed Postgres on 100,000 nodes? In the future we're going to take a look at building some example 'profiles' to be found under examples/ within this module that can uninstall postgres on popular platforms. These can be modified and used in your specific case to uninstall postgresql. They will be much more brute force and reliant on deleting entire directories and require you to do more work up front in specifying where things are installed but we think it'll prove to be a much cleaner mechanism for this kind of thing rather than trying to weave it into the main module logic itself.
####Features
- Removal of uninstall.
- Removal of firewall management.
- Tests ported to rspec3.
- Acceptance tests rewritten.
- Add a defined type for creating database schemas.
- Add a pg_ident_rule defined type.
- Set manage_pg_ident_conf to true.
- Manage pg_ident.conf by default.
- Improve selinux support for tablespace.
- Remove deprecation warnings.
- Support changing PGDATA on RedHat.
- Add SLES 11 support.
####Bugfixes
- Link pg_config binary into /usr/bin.
- Fix fedora support by using systemd.
- Initdb should create xlogdir if set.
##2014-08-27 - Supported Release 3.4.3 ###Summary
This release fixes Ubuntu 10.04 with Facter 2.2.
####Features ####Bugfixes
- Use a regular expression to match the major OS version on Ubuntu.
##2014-07-31 - Supported Release 3.4.2 ###Summary
This release fixes recent Fedora versions.
####Features ####Bugfixes
- Fix Fedora.
##2014-07-15 - Supported Release 3.4.1 ###Summary
This release merely updates metadata.json so the module can be uninstalled and upgraded via the puppet module command.
##2014-04-14 - Supported Release 3.4.0 ###Summary
This feature rolls up several important features, the biggest being PostGIS
handling and allowing port
to be set on postgresql::server in order to
change the port that Postgres listens on. We've added support for RHEL7
and Ubuntu 14.04, as well as allowing you to manage the service via
service_ensure
finally.
####Features
- Added
perl_package_name
for installing bindings. - Added
service_ensure
for allowing control of services. - Added
postgis_version
and postgis class for installing postgis. - Added
port
for selecting the port Postgres runs on. - Add support for RHEL7 and Ubuntu 14.04.
- Add
default_db
to postgresql::server::database. - Widen the selection of unquoted parameters in postgresql_conf{}
- Require the service within postgresql::server::reload for RHEL7.
- Add
inherit
to postgresql::server::role.
####Bugfixes
##2014-03-04 - Supported Release 3.3.3 ###Summary
This is a supported release. This release removes a testing symlink that can cause trouble on systems where /var is on a seperate filesystem from the modulepath.
####Features ####Bugfixes ####Known Bugs
- SLES is not supported.
##2014-03-04 - Supported Release 3.3.2 ###Summary This is a supported release. It fixes a problem with updating passwords on postgresql.org distributed versions of PostgreSQL.
####Bugfixes
- Correct psql path when setting password on custom versions.
- Documentation updates
- Test updates
####Known Bugs
- SLES is not supported.
##2014-02-12 - Version 3.3.1 ####Bugfix:
- Allow dynamic rubygems host
##2014-01-28 - Version 3.3.0
###Summary
This release rolls up a bunch of bugfixes our users have found and fixed for us over the last few months. This improves things for 9.1 users, and makes this module usable on FreeBSD.
This release is dedicated to 'bma', who's suffering with Puppet 3.4.1 issues thanks to Puppet::Util::SUIDManager.run_and_capture.
####Features
- Add lc_ config entry settings
- Can pass template at database creation.
- Add FreeBSD support.
- Add support for customer
xlogdir
parameter. - Switch tests from rspec-system to beaker. (This isn't really a feature)
####Bugfixes
- Properly fix the deprecated Puppet::Util::SUIDManager.run_and_capture errors.
- Fix NOREPLICATION option for Postgres 9.1
- Wrong parameter name: manage_pg_conf -> manage_pg_hba_conf
- Add $postgresql::server::client_package_name, referred to by install.pp
- Add missing service_provider/service_name descriptions in ::globals.
- Fix several smaller typos/issues throughout.
- Exec['postgresql_initdb'] needs to be done after $datadir exists
- Prevent defined resources from floating in the catalog.
- Fix granting all privileges on a table.
- Add some missing privileges.
- Remove deprecated and unused concat::fragment parameters.
##2013-11-05 - Version 3.2.0
###Summary
Add's support for Ubuntu 13.10 (and 14.04) as well as x, y, z.
####Features
- Add versions for Ubuntu 13.10 and 14.04.
- Use default_database in validate_db_connection instead of a hardcoded 'postgres'
- Add globals/params layering for default_database.
- Allow specification of default database name.
####Bugs
- Fixes to the README.
##2013-10-25 - Version 3.1.0
###Summary
This is a minor feature and bug fix release.
Firstly, the postgresql_psql type now includes a new parameter search_path
which is equivalent to using set search_path
which allows you to change the default schema search path.
The default version of Fedora 17 has now been added, so that Fedora 17 users can enjoy the module.
And finally we've extended the capabilities of the defined type postgresql::validate_db_connection so that now it can handle retrying and sleeping between retries. This feature has been monopolized to fix a bug we were seeing with startup race conditions, but it can also be used by remote systems to 'wait' for PostgreSQL to start before their Puppet run continues.
####Features
- Defined $default_version for Fedora 17 (Bret Comnes)
- add search_path attribute to postgresql_psql resource (Jeremy Kitchen)
- (GH-198) Add wait and retry capability to validate_db_connection (Ken Barber)
####Bugs
- enabling defined postgres user password without resetting on every puppet run (jonoterc)
- periods are valid in configuration variables also (Jeremy Kitchen)
- Add zero length string to join() function (Jarl Stefansson)
- add require of install to reload class (cdenneen)
- (GH-198) Fix race condition on postgresql startup (Ken Barber)
- Remove concat::setup for include in preparation for the next concat release (Ken Barber)
##2013-10-14 - Version 3.0.0
Final release of 3.0, enjoy!
##2013-10-14 - Version 3.0.0-rc3
###Summary
Add a parameter to unmanage pg_hba.conf to fix a regression from 2.5, as well as allowing owner to be passed into x.
####Features
manage_pg_hba_conf
parameter added to control pg_hba.conf management.owner
parameter added to server::db.
##2013-10-09 - Version 3.0.0-rc2
###Summary
A few bugfixes have been found since -rc1.
####Fixes
- Special case for $datadir on Amazon
- Fix documentation about username/password for the postgresql_hash function
##2013-10-01 - Version 3.0.0-rc1
###Summary
Version 3 was a major rewrite to fix some internal dependency issues, and to make the new Public API more clear. As a consequence a lot of things have changed for version 3 and older revisions that we will try to outline here.
(NOTE: The format of this CHANGELOG differs to normal in an attempt to explain the scope of changes)
- Server specific objects now moved under
postgresql::server::
namespace:
To restructure server specific elements under the postgresql::server::
namespaces the following objects were renamed as such:
postgresql::database
-> postgresql::server::database
postgresql::database_grant
-> postgresql::server::database_grant
postgresql::db
-> postgresql::server::db
postgresql::grant
-> postgresql::server::grant
postgresql::pg_hba_rule
-> postgresql::server::pg_hba_rule
postgresql::plperl
-> postgresql::server::plperl
postgresql::contrib
-> postgresql::server::contrib
postgresql::role
-> postgresql::server::role
postgresql::table_grant
-> postgresql::server::table_grant
postgresql::tablespace
-> postgresql::server::tablespace
- New
postgresql::server::config_entry
resource for managing configuration:
Previously we used the file_line
resource to modify postgresql.conf
. This
new revision now adds a new resource named postgresql::server::config_entry
for managing this file. For example:
postgresql::server::config_entry { 'check_function_bodies':
value => 'off',
}
If you were using file_line
for this purpose, you should change to this new
methodology.
postgresql_puppet_extras.conf
has been removed:
Now that we have a methodology for managing postgresql.conf
, and due to
concerns over the file management methodology using an exec { 'touch ...': }
as a way to create an empty file the existing postgresql_puppet_extras.conf
file is no longer managed by this module.
If you wish to recreate this methodology yourself, use this pattern:
class { 'postgresql::server': }
$extras = "/tmp/include.conf"
file { $extras:
content => 'max_connections = 123',
notify => Class['postgresql::server::service'],
}->
postgresql::server::config_entry { 'include':
value => $extras,
}
- All uses of the parameter
charset
changed toencoding
:
Since PostgreSQL uses the terminology encoding
not charset
the parameter
has been made consisent across all classes and resources.
- The
postgresql
base class is no longer how you set globals:
The old global override pattern was less then optimal so it has been fixed,
however we decided to demark this properly by specifying these overrides in
the class postgresql::global
. Consult the documentation for this class now
to see what options are available.
Also, some parameter elements have been moved between this and the
postgresql::server
class where it made sense.
config_hash
parameter collapsed for thepostgresql::server
class:
Because the config_hash
was really passing data through to what was in
effect an internal class (postgresql::config
). And since we don't want this
kind of internal exposure the parameters were collapsed up into the
postgresql::server
class directly.
- Lots of changes to 'private' or 'undocumented' classes:
If you were using these before, these have changed names. You should only use what is documented in this README.md, and if you don't have what you need you should raise a patch to add that feature to a public API. All internal classes now have a comment at the top indicating them as private to make sure the message is clear that they are not supported as Public API.
pg_hba_conf_defaults
parameter included to turn off default pg_hba rules:
The defaults should be good enough for most cases (if not raise a bug) but if you simply need an escape hatch, this setting will turn off the defaults. If you want to do this, it may affect the rest of the module so make sure you replace the rules with something that continues operation.
postgresql::database_user
has now been removed:
Use postgresql::server::role
instead.
postgresql::psql
resource has now been removed:
Use postgresql_psql
instead. In the future we may recreate this as a wrapper
to add extra capability, but it will not match the old behaviour.
postgresql_default_version
fact has now been removed:
It didn't make sense to have this logic in a fact any more, the logic has been
moved into postgresql::params
.
ripienaar/concat
is no longer used, instead we usepuppetlabs/concat
:
The older concat module is now deprecated and moved into the
puppetlabs/concat
namespace. Functionality is more or less identical, but
you may need to intervene during the installing of this package - as both use
the same concat
namespace.
##2013-09-09 Release 2.5.0
###Summary
The focus of this release is primarily to capture the fixes done to the types and providers to make sure refreshonly works properly and to set the stage for the large scale refactoring work of 3.0.0.
####Features
####Bugfixes
- Use boolean for refreshonly.
- Fix postgresql::plperl documentation.
- Add two missing parameters to config::beforeservice
- Style fixes
##2013-08-01 Release 2.4.1
###Summary
This minor bugfix release solves an idempotency issue when using plain text passwords for the password_hash parameter for the postgresql::role defined type. Without this, users would continually see resource changes everytime your run Puppet.
####Bugfixes
- Alter role call not idempotent with cleartext passwords (Ken Barber)
##2013-07-19 Release 2.4.0
###Summary
This updates adds the ability to change permissions on tables, create template
databases from normal databases, manage PL-Perl's postgres package, and
disable the management of pg_hba.conf
.
####Features
- Add
postgresql::table_grant
defined resource - Add
postgresql::plperl
class - Add
manage_pg_hba_conf
parameter to thepostgresql::config
class - Add
istemplate
parameter to thepostgresql::database
define
####Bugfixes
- Update
postgresql::role
class to be able to update roles when modified instead of only on creation. - Update tests
- Fix documentation of
postgresql::database_grant
##2.3.0
This feature release includes the following changes:
- Add a new parameter
owner
to thedatabase
type. This can be used to grant ownership of a new database to a specific user. (Bruno Harbulot) - Add support for operating systems other than Debian/RedHat, as long as the user supplies custom values for all of the required paths, package names, etc. (Chris Price)
- Improved integration testing (Ken Barber)
##2.2.1
This release fixes a bug whereby one of our shell commands (psql) were not ran from a globally accessible directory. This was causing permission denied errors when the command attempted to change user without changing directory.
Users of previous versions might have seen this error:
Error: Error executing SQL; psql returned 256: 'could not change directory to "/root"
This patch should correct that.
Detail Changes
- Set /tmp as default CWD for postgresql_psql
##2.2.0
This feature release introduces a number of new features and bug fixes.
First of all it includes a new class named postgresql::python
which provides you with a convenient way of install the python Postgresql client libraries.
class { 'postgresql::python':
}
You are now able to use postgresql::database_user
without having to specify a password_hash, useful for different authentication mechanisms that do not need passwords (ie. cert, local etc.).
We've also provided a lot more advanced custom parameters now for greater control of your Postgresql installation. Consult the class documentation for PuppetDB in the README.
This release in particular has largely been contributed by the community members below, a big thanks to one and all.
Detailed Changes
- Add support for psycopg installation (Flaper Fesp and Dan Prince)
- Added default PostgreSQL version for Ubuntu 13.04 (Kamil Szymanski)
- Add ability to create users without a password (Bruno Harbulot)
- Three Puppet 2.6 fixes (Dominic Cleal)
- Add explicit call to concat::setup when creating concat file (Dominic Cleal)
- Fix readme typo (Jordi Boggiano)
- Update postgres_default_version for Ubuntu (Kamil Szymanski)
- Allow to set connection for noew role (Kamil Szymanski)
- Fix pg_hba_rule for postgres local access (Kamil Szymanski)
- Fix versions for travis-ci (Ken Barber)
- Add replication support (Jordi Boggiano)
- Cleaned up and added unit tests (Ken Barber)
- Generalization to provide more flexability in postgresql configuration (Karel Brezina)
- Create dependent directory for sudoers so tests work on Centos 5 (Ken Barber)
- Allow SQL commands to be run against a specific DB (Carlos Villela)
- Drop trailing comma to support Puppet 2.6 (Michael Arnold)
##2.1.1
This release provides a bug fix for RHEL 5 and Centos 5 systems, or specifically systems using PostgreSQL 8.1 or older. On those systems one would have received the error:
Error: Could not start Service[postgresqld]: Execution of ‘/sbin/service postgresql start’ returned 1:
And the postgresql log entry:
FATAL: unrecognized configuration parameter "include"
This bug is due to a new feature we had added in 2.1.0, whereby the include
directive in postgresql.conf
was not compatible. As a work-around we have added checks in our code to make sure systems running PostgreSQL 8.1 or older do not have this directive added.
Detailed Changes
2013-01-21 - Ken Barber ken@bob.sh
- Only install
include
directive and included file on PostgreSQL >= 8.2 - Add system tests for Centos 5
##2.1.0
This release is primarily a feature release, introducing some new helpful constructs to the module.
For starters, we've added the line include 'postgresql_conf_extras.conf'
by default so extra parameters not managed by the module can be added by other tooling or by Puppet itself. This provides a useful escape-hatch for managing settings that are not currently managed by the module today.
We've added a new defined resource for managing your tablespace, so you can now create new tablespaces using the syntax:
postgresql::tablespace { 'dbspace':
location => '/srv/dbspace',
}
We've added a locale parameter to the postgresql
class, to provide a default. Also the parameter has been added to the postgresql::database
and postgresql::db
defined resources for changing the locale per database:
postgresql::db { 'mydatabase':
user => 'myuser',
password => 'mypassword',
encoding => 'UTF8',
locale => 'en_NG',
}
There is a new class for installing the necessary packages to provide the PostgreSQL JDBC client jars:
class { 'postgresql::java': }
And we have a brand new defined resource for managing fine-grained rule sets within your pg_hba.conf access lists:
postgresql::pg_hba { 'Open up postgresql for access from 200.1.2.0/24':
type => 'host',
database => 'app',
user => 'app',
address => '200.1.2.0/24',
auth_method => 'md5',
}
Finally, we've also added Travis-CI support and unit tests to help us iterate faster with tests to reduce regression. The current URL for these tests is here: https://travis-ci.org/puppetlabs/puppet-postgresql. Instructions on how to run the unit tests available are provided in the README for the module.
A big thanks to all those listed below who made this feature release possible :-).
Detailed Changes
2013-01-18 - Simão Fontes simaofontes@gmail.com & Flaper Fesp flaper87@gmail.com
- Remove trailing commas from params.pp property definition for Puppet 2.6.0 compatibility
2013-01-18 - Lauren Rother lauren.rother@puppetlabs.com
- Updated README.md to conform with best practices template
2013-01-09 - Adrien Thebo git@somethingsinistral.net
- Update postgresql_default_version to 9.1 for Debian 7.0
2013-01-28 - Karel Brezina karel.brezina@gmail.com
- Add support for tablespaces
2013-01-16 - Chris Price chris@puppetlabs.com & Karel Brezina karel.brezina@gmail.com
- Provide support for an 'include' config file 'postgresql_conf_extras.conf' that users can modify manually or outside of the module.
2013-01-31 - jv jeff@jeffvier.com
- Fix typo in README.pp for postgresql::db example
2013-02-03 - Ken Barber ken@bob.sh
- Add unit tests and travis-ci support
2013-02-02 - Ken Barber ken@bob.sh
- Add locale parameter support to the 'postgresql' class
2013-01-21 - Michael Arnold github@razorsedge.org
- Add a class for install the packages containing the PostgreSQL JDBC jar
2013-02-06 - fhrbek filip.hbrek@gmail.com
- Coding style fixes to reduce warnings in puppet-lint and Geppetto
2013-02-10 - Ken Barber ken@bob.sh
- Provide new defined resource for managing pg_hba.conf
2013-02-11 - Ken Barber ken@bob.sh
- Fix bug with reload of Postgresql on Redhat/Centos
2013-02-15 - Erik Dalén dalen@spotify.com
- Fix more style issues to reduce warnings in puppet-lint and Geppetto
2013-02-15 - Erik Dalén dalen@spotify.com
- Fix case whereby we were modifying a hash after creation
##2.0.1
Minor bugfix release.
2013-01-16 - Chris Price chris@puppetlabs.com
- Fix revoke command in database.pp to support postgres 8.1 (43ded42)
2013-01-15 - Jordi Boggiano j.boggiano@seld.be
- Add support for ubuntu 12.10 status (3504405)
##2.0.0
Many thanks to the following people who contributed patches to this release:
- Adrien Thebo
- Albert Koch
- Andreas Ntaflos
- Brett Porter
- Chris Price
- dharwood
- Etienne Pelletier
- Florin Broasca
- Henrik
- Hunter Haugen
- Jari Bakken
- Jordi Boggiano
- Ken Barber
- nzakaria
- Richard Arends
- Spenser Gilliland
- stormcrow
- William Van Hevelingen
Notable features:
-
Add support for versions of postgres other than the system default version (which varies depending on OS distro). This includes optional support for automatically managing the package repo for the "official" postgres yum/apt repos. (Major thanks to Etienne Pelletier epelletier@maestrodev.com and Ken Barber ken@bob.sh for their tireless efforts and patience on this feature set!) For example usage see
tests/official-postgresql-repos.pp
. -
Add some support for Debian Wheezy and Ubuntu Quantal
-
Add new
postgres_psql
type with a Ruby provider, to replace the old exec-basedpsql
type. This gives us much more flexibility around executing SQL statements and controlling their logging / reports output. -
Major refactor of the "spec" tests--which are actually more like acceptance tests. We now support testing against multiple OS distros via vagrant, and the framework is in place to allow us to very easily add more distros. Currently testing against Cent6 and Ubuntu 10.04.
-
Fixed a bug that was preventing multiple databases from being owned by the same user (9adcd182f820101f5e4891b9f2ff6278dfad495c - Etienne Pelletier epelletier@maestrodev.com)
-
Add support for ACLs for finer-grained control of user/interface access (b8389d19ad78b4fb66024897097b4ed7db241930 - dharwood harwoodd@cat.pdx.edu)
-
Many other bug fixes and improvements!
##1.0.0
2012-09-17 - Version 0.3.0 released
2012-09-14 - Chris Price chris@puppetlabs.com
- Add a type for validating a postgres connection (ce4a049)
2012-08-25 - Jari Bakken jari.bakken@gmail.com
- Remove trailing commas. (e6af5e5)
2012-08-16 - Version 0.2.0 released
Dependencies
- puppetlabs/stdlib (>= 4.9.0 < 5.0.0)
- puppetlabs/apt (>=1.1.0 <2.0.0)
- simp/simpcat (>= 5.0.1 < 6.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2013 Puppet Labs Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.