postgresql

Setup postgresql

Module Stats

7,968 downloads

6,924 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released May 18th 2018

This version is compatible with:

Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >= 4.7.0 < 6.0.0

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetfinland-postgresql', '1.0.4'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetfinland-postgresql

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetfinland-postgresql --version 1.0.4

Documentation

puppetfinland/postgresql — version 1.0.4 May 18th 2018

postgresql

A Puppet module for managing postgresql servers and configuring database dumps. Reuses providers from puppetlabs-postgresql. Includes optional firewall and monit support.

Module usage

Setup latest postgresql version from the project's repositories:

class { '::postgresql':
  use_latest_release => true,
}

Configure a backup job with default settings:

postgresql::backup { 'my_database_name': }

Customize backup schedule:

postgresql::backup { 'my_database_name':
  hour    => 4,
  minute  => 45,
  weekday => *',
}

The $pg_dump_extra_params parameter can be used to customize the backup job further.

To load an SQL file (generally from another module):

postgresql::loadsql { 'bacula-bacula-director.sql':
  modulename => 'bacula',
  basename   => 'bacula-director',
}

For details see init.pp, backup.pp and loadsql.pp

Usage instructions for the bundled types and providers is here:

https://github.com/puppetlabs/puppetlabs-postgresql

License

Most classes and defines are licensed under the BSD license (see file LICENSE.BSD). The types, providers and classes included from postgresql::softwarerepo class have been taken from puppetlabs-postgresql (HEAD at 0ffbcc0). These files are thus covered by the Apache 2.0 license (see file LICENSE.APACHE).

Types in this module release

postgresql_conn_validator

Verify that a connection can be successfully established between a node and the PostgreSQL server. Its primary use is as a precondition to prevent configuration changes from being applied if the PostgreSQL server cannot be reached, but it could potentially be used for other purposes such as monitoring.

Parameters
command	Command to run against target database.
connect_settings	Hash of environment variables for connection to a db.
db_name	The name of the database you are trying to validate a connection with.
db_password	The password required to access the target PostgreSQL database.
db_username	A user that has access to the target PostgreSQL database.
ensure
host	The DNS name or IP address of the server where PostgreSQL should be running.
name	An arbitrary name used as the identity of the resource.
port	The port that the PostgreSQL server should be listening on.
provider
psql_path	Path to the psql command.
run_as	System user that will run the psql command.
sleep	The length of sleep time between connection tries.
tries	The number of tries to validate the connection to the target PostgreSQL database.

Providers
ruby	A provider for the resource type `postgresql_conn_validator`, which validates the PostgreSQL connection by attempting a query to the target PostgreSQL server.

postgresql_psql

Parameters
connect_settings	Connection settings that will be used when connecting to postgres
cwd	The working directory under which the psql command should be executed.
db	The name of the database to execute the SQL command against, this overrides any PGDATABASE value in connect_settings
environment	Any additional environment variables you want to set for a SQL command. Multiple environment variables should be specified as an array.
name	An arbitrary tag for your own reference; the name of the message.
onlyif	An optional SQL command to execute prior to the main :command; this is generally intended to be used for idempotency, to check for the existence of an object in the database to determine whether or not the main SQL command needs to be executed at all.
port	The port of the database server to execute the SQL command against, this overrides any PGPORT value in connect_settings.
provider
psql_group	The system user group account under which the psql command should be executed.
psql_path	The path to psql executable.
psql_user	The system user account under which the psql command should be executed.
refreshonly	If 'true', then the SQL will only be executed via a notify/subscribe event.
search_path	The schema search path to use when executing the SQL command
unless	An optional SQL command to execute prior to the main :command; this is generally intended to be used for idempotency, to check for the existence of an object in the database to determine whether or not the main SQL command needs to be executed at all.

Properties
command	The SQL command to execute via psql.

Providers
ruby

postgresql_replication_slot

Manages Postgresql replication slots.

This type allows to create and destroy replication slots to register warm standby replication on a Postgresql master server.

Parameters
ensure
name	The name of the slot to create. Must be a valid replication slot name.
provider

Providers
ruby

postgresql_conf

This type allows puppet to manage postgresql.conf parameters.

Parameters
ensure
name	The postgresql parameter name to manage.
provider

Properties
target	The path to postgresql.conf
value	The value to set for this parameter.

Providers
parsed	Set key/values in postgresql.conf.

Copyright 2016 Samuli Seppänen, 2017 OpenVPN, Inc.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this 
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation and/or 
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

postgresql

Contributions Requested

PDK

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

postgresql

Module usage

License

Types in this module release

postgresql_conn_validator

postgresql_psql

postgresql_replication_slot

postgresql_conf

Dependencies