opuppet/module-postgresql
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
module-postgresql/README.md

1021 lines
45 KiB
Markdown
Raw Normal View History

Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
postgresql
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
==========
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Table of Contents
-----------------
Adjust ownership to Puppet Labs Prior to this commit, Inkling Systems was responsible for improving and maintaining this module. The maintainer has moved on and Inkling wished for Puppet Labs to continue with this modules maintenance. This commit adjusts the README and Modulefile for this change in ownership.
2012-10-24 19:20:20 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
1. [Overview - What is the PostgreSQL module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with PostgreSQL module](#setup)
Fixed broken internal resource links.
2014-12-05 17:55:04 +01:00
* [PE 3.2 supported module](#pe-32-supported-module)
Add install instructions for supported module version Adds a section to Setup for PE 3.2 users wanting to use the supported vs. shipped version of this module.
2014-03-03 21:36:07 +01:00
* [Configuring the server](#configuring-the-server)
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
4. [Usage - How to use the module for various tasks](#usage)
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
5. [Upgrading - Guide for upgrading from older revisions of this module](#upgrading)
6. [Reference - The classes, defines,functions and facts available in this module](#reference)
7. [Limitations - OS compatibility, etc.](#limitations)
8. [Development - Guide for contributing to the module](#development)
9. [Disclaimer - Licensing information](#disclaimer)
10. [Transfer Notice - Notice of authorship change](#transfer-notice)
11. [Contributors - List of module contributors](#contributors)
Initial commit
2012-04-20 00:37:18 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Overview
--------
Initial commit
2012-04-20 00:37:18 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
The PostgreSQL module allows you to easily manage postgres databases with Puppet.
Initial commit
2012-04-20 00:37:18 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Module Description
-------------------
Initial commit
2012-04-20 00:37:18 +02:00
Remove firewall management The firewall management really belongs outside of the module that manages postgresql, like in a profile.
2014-08-21 20:12:23 +02:00
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.
Initial commit
2012-04-20 00:37:18 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Setup
-----
**What puppetlabs-PostgreSQL affects:**
* package/service/configuration files for PostgreSQL
* listened-to ports
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
* IP and mask (optional)
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
**Introductory Questions**
The postgresql module offers many security configuration settings. Before getting started, you will want to consider:
Initial commit
2012-04-20 00:37:18 +02:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
* 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?
Add sample usage for postgresql::server class. I had some issues trying to connect to the server, managed with defaults: vagrant@precise32:~$ psql psql: FATAL: role "vagrant" does not exist vagrant@precise32:~$ psql -U postgres psql: FATAL: Peer authentication failed for user "postgres" vagrant@precise32:~$ psql -U postgres -h 127.0.0.1 psql: FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL on FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL off vagrant@precise32:~$ psql -U postgres -h /var/run/postgresql psql: FATAL: Peer authentication failed for user "postgres" After some trial and error I found out that the reasons for this was restrictive permissions on the unix socket (which isn't bad at all): vagrant@precise32:~$ ls -l /var/run/postgresql/ total 4 -rw------- 1 postgres postgres 5 Oct 16 20:16 9.1-main.pid So I though I send some usage examples to help noops like myself to a quicker start with your module :-)
2012-10-16 23:24:17 +02:00
Fixed typos, rewording and typsetting per feedback Updated spelling errors, typsetting issues and some wording suggestions based on module author feedback
2013-01-23 00:16:21 +01:00
Your answers to these questions will determine which of the module's parameters you'll want to specify values for.
Add sample usage for postgresql::server class. I had some issues trying to connect to the server, managed with defaults: vagrant@precise32:~$ psql psql: FATAL: role "vagrant" does not exist vagrant@precise32:~$ psql -U postgres psql: FATAL: Peer authentication failed for user "postgres" vagrant@precise32:~$ psql -U postgres -h 127.0.0.1 psql: FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL on FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL off vagrant@precise32:~$ psql -U postgres -h /var/run/postgresql psql: FATAL: Peer authentication failed for user "postgres" After some trial and error I found out that the reasons for this was restrictive permissions on the unix socket (which isn't bad at all): vagrant@precise32:~$ ls -l /var/run/postgresql/ total 4 -rw------- 1 postgres postgres 5 Oct 16 20:16 9.1-main.pid So I though I send some usage examples to help noops like myself to a quicker start with your module :-)
2012-10-16 23:24:17 +02:00
Add install instructions for supported module version Adds a section to Setup for PE 3.2 users wanting to use the supported vs. shipped version of this module.
2014-03-03 21:36:07 +01:00
###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](http://puppetlabs.com/services/customer-support) channels. If you would like to access the [supported module](http://forge.puppetlabs.com/supported) 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
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
###Configuring the server
Add sample usage for postgresql::server class. I had some issues trying to connect to the server, managed with defaults: vagrant@precise32:~$ psql psql: FATAL: role "vagrant" does not exist vagrant@precise32:~$ psql -U postgres psql: FATAL: Peer authentication failed for user "postgres" vagrant@precise32:~$ psql -U postgres -h 127.0.0.1 psql: FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL on FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL off vagrant@precise32:~$ psql -U postgres -h /var/run/postgresql psql: FATAL: Peer authentication failed for user "postgres" After some trial and error I found out that the reasons for this was restrictive permissions on the unix socket (which isn't bad at all): vagrant@precise32:~$ ls -l /var/run/postgresql/ total 4 -rw------- 1 postgres postgres 5 Oct 16 20:16 9.1-main.pid So I though I send some usage examples to help noops like myself to a quicker start with your module :-)
2012-10-16 23:24:17 +02:00
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
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:
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
class { 'postgresql::server': }
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
For a more customized configuration:
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
class { 'postgresql::server':
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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!',
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
}
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Once you've completed your configuration of `postgresql::server`, you can test out your settings from the command line:
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
$ psql -h localhost -U postgres
$ psql -h my.postgres.server -U
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
For more details about server configuration parameters consult the [PostgreSQL Runtime Configuration docs](http://www.postgresql.org/docs/9.2/static/runtime-config.html).
Usage
-----
Added info about the advanced configuration file
2013-02-01 12:26:39 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
###Creating a database
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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': }
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
postgresql::server::db { 'mydatabasename':
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
user => 'mydatabaseuser',
Fix documentation about username/password for the postgresql_hash function This is messed up in different ways and this commit brings it in align with what the function actually does.
2013-10-07 18:39:30 +02:00
password => postgresql_password('mydatabaseuser', 'mypassword'),
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
}
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
###Managing users, roles and permissions
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
To manage users, roles and permissions:
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
class { 'postgresql::server': }
postgresql::server::role { 'marmot':
Fix documentation about username/password for the postgresql_hash function This is messed up in different ways and this commit brings it in align with what the function actually does.
2013-10-07 18:39:30 +02:00
password_hash => postgresql_password('marmot', 'mypasswd'),
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
}
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
postgresql::server::database_grant { 'test1':
Update readme
2013-07-16 21:50:44 +02:00
privilege => 'ALL',
db => 'test1',
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
role => 'marmot',
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
}
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
postgresql::server::table_grant { 'my_table of test2':
Update readme
2013-07-16 21:50:44 +02:00
privilege => 'ALL',
table => 'my_table',
db => 'test2',
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
role => 'marmot',
Update readme
2013-07-16 21:50:44 +02:00
}
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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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:
Prepare 3.0.0 release.
2013-10-01 19:00:57 +02:00
* `postgresql::database` -> `postgresql::server::database`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
* `postgresql::database_grant` -> `postgresql::server::database_grant`
Prepare 3.0.0 release.
2013-10-01 19:00:57 +02:00
* `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`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####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.
Prepare 3.0.0 release.
2013-10-01 19:00:57 +02:00
####`postgresql_puppet_extras.conf` has been removed
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Prepare 3.0.0 release.
2013-10-01 19:00:57 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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
Misspelled class postgresql::globals (missing ending 's' in some cases)
2013-10-31 03:51:16 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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`.
Prepare 3.0.0 release.
2013-10-01 19:00:57 +02:00
####`ripienaar/concat` is no longer used, instead we use `puppetlabs/concat`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Classes:
* [postgresql::client](#class-postgresqlclient)
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
* [postgresql::globals](#class-postgresqlglobals)
* [postgresql::lib::devel](#class-postgresqllibdevel)
* [postgresql::lib::java](#class-postgresqllibjava)
Add class postgresql::lib::perl for perl support
2014-04-02 23:52:07 +02:00
* [postgresql::lib::perl](#class-postgresqllibperl)
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
* [postgresql::lib::python](#class-postgresqllibpython)
* [postgresql::server](#class-postgresqlserver)
* [postgresql::server::plperl](#class-postgresqlserverplperl)
Rename contrib to server::contrib Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-20 15:35:24 +02:00
* [postgresql::server::contrib](#class-postgresqlservercontrib)
add support for postgis rhel support added by @mcanevet, but the branch has been squashed. thanks!
2013-10-16 21:46:50 +02:00
* [postgresql::server::postgis](#class-postgresqlserverpostgis)
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Resources:
doc: Fix anchor links in README TOC Several of the anchor links in the README's table of contents were broken because of missing underscores.
2014-07-30 19:44:16 +02:00
* [postgresql::server::config_entry](#resource-postgresqlserverconfig_entry)
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
* [postgresql::server::db](#resource-postgresqlserverdb)
* [postgresql::server::database](#resource-postgresqlserverdatabase)
doc: Fix anchor links in README TOC Several of the anchor links in the README's table of contents were broken because of missing underscores.
2014-07-30 19:44:16 +02:00
* [postgresql::server::database_grant](#resource-postgresqlserverdatabase_grant)
* [postgresql::server::pg_hba_rule](#resource-postgresqlserverpg_hba_rule)
Fixed broken internal resource links.
2014-12-05 17:55:04 +01:00
* [postgresql::server::pg_ident_rule](#resource-postgresqlserverpg_ident_rule)
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
* [postgresql::server::role](#resource-postgresqlserverrole)
defined type for creating database schemas This defined type helps create database schemas, and assign them to an `owner`. It is closely modeled after Postgresql::Server::Tablespace. It uses PostgreSQL's builtin IF NOT EXISTS to guarantee idempotency. (>= 9.3, else it checks pg_namespace). n.b.: This defined type *requires* that a `db` is passed. This is a concious design decision, since we find it rather useless to create such schemas in the default `postgres` database, and if *were* useful, one can always "over-specify". This addresses MODULES-1098.
2014-07-04 14:35:32 +02:00
* [postgresql::server::schema](#resource-postgresqlserverschema)
doc: Fix anchor links in README TOC Several of the anchor links in the README's table of contents were broken because of missing underscores.
2014-07-30 19:44:16 +02:00
* [postgresql::server::table_grant](#resource-postgresqlservertable_grant)
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
* [postgresql::server::tablespace](#resource-postgresqlservertablespace)
doc: Fix anchor links in README TOC Several of the anchor links in the README's table of contents were broken because of missing underscores.
2014-07-30 19:44:16 +02:00
* [postgresql::validate_db_connection](#resource-postgresqlvalidate_db_connection)
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Functions:
doc: Fix anchor links in README TOC Several of the anchor links in the README's table of contents were broken because of missing underscores.
2014-07-30 19:44:16 +02:00
* [postgresql\_password](#function-postgresql_password)
* [postgresql\_acls\_to\_resources\_hash](#function-postgresql_acls_to_resources_hashacl_array-id-order_offset)
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
For example, if you wanted to overwrite the default `locale` and `encoding` for all classes you could use the following combination:
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Misspelled class postgresql::globals (missing ending 's' in some cases)
2013-10-31 03:51:16 +01:00
class { 'postgresql::globals':
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
encoding => 'UTF8',
locale => 'en_NG',
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
}->
class { 'postgresql::server':
}
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
That would make the `encoding` and `locale` the default for all classes and defined resources in this module.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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:
Cleaned up and added unit tests Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-18 16:06:44 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
class { 'postgresql::globals':
manage_package_repo => true,
version => '9.2',
Added missing depedenncy '->' in the Class: postgresql::globals usage example
2013-10-31 03:41:08 +01:00
}->
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
class { 'postgresql::server': }
Cleaned up and added unit tests Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-18 16:06:44 +01:00
####`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.
Add documentation, rspec test and support for global overriding contrib package name
2013-03-02 10:49:57 +01:00
####`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.
Cleaned up and added unit tests Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-18 16:06:44 +01:00
####`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.
Add class postgresql::lib::perl for perl support
2014-04-02 23:52:07 +02:00
####`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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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.
Add `service_ensure`. This allows you to control the status of the Postgresql service directly from postgresql::server.
2014-05-08 22:43:22 +02:00
####`service_ensure`
This setting can be used to override the default postgresql service ensure status. If not specified, the module will use `ensure` instead.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`service_name`
Missing service_provider description and wrong service_name description for postgresql::globals class
2013-12-24 03:09:12 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`service_status`
Missing service_provider description and wrong service_name description for postgresql::globals class
2013-12-24 03:09:12 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Add globals/params layering for default_database This makes the variable consistent with the manner in which most/all of the rest of the postgresql module currently works. Commit also adds the new param to the README file.
2013-10-27 02:50:05 +02:00
####`default_database`
This setting is used to specify the name of the default database to connect with. On most systems this will be "postgres".
Spelling and redundancy fix in README
2013-10-30 20:27:12 +01:00
####`initdb_path`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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.
Create the pg_ident_rule defined type This allows us to declare user map as easilly as pg_hba entries.
2014-07-24 22:04:02 +02:00
####`pg_ident_conf_path`
Path to your `pg\_ident.conf` file.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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`
Fix data directory handling The change introduced in b781849882ee5b36135f8d3abafa449721e19565 added a complex operation that was not handled correctly for all operating systems. This fix includes the following corrections: - Change the systemd config and reload systemd for datadir changes in RHEL 7, and move configuration for this into postgresql::server::config since it is managing both the PGDATA and PGPORT variables - Make sure Debian systems stop the service before changing the datadir - Recreate cert links after running initdb in Debian and early ubuntu - Change the port in the port spec to avoid selinux issues - Turn off selinux in pgdata spec to avoid selinux issues - Correct syntax for describing presence of a directory in pgdata spec - Move the pgdata spec to the end of the tests so that puppet doesn't have to manager purging and recreating the original datadir - Update README to describe all caveats of using this parameter
2014-10-31 23:27:34 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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.
Added xlogdir test to basic install/db creation validation test. Updated README
2013-12-13 22:41:25 +01:00
####`xlogdir`
This setting can be used to override the default postgresql xlog directory. If not specified the module will use initdb's default path.
Cleaned up and added unit tests Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-18 16:06:44 +01:00
####`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'.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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.
add support for postgis rhel support added by @mcanevet, but the branch has been squashed. thanks!
2013-10-16 21:46:50 +02:00
####`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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`needs_initdb`
Cleaned up and added unit tests Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-18 16:06:44 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`encoding`
Rename contrib to server::contrib Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-20 15:35:24 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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`.
Ensure we call out the locales-all requirement.
2014-02-28 23:32:13 +01:00
#####Debian
On Debian you'll need to ensure that the 'locales-all' package is installed for full functionality of Postgres.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`manage_package_repo`
If `true` this will setup the official PostgreSQL repositories on your host. Defaults to `false`.
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
###Class: postgresql::server
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
The following list are options that you can set in the `config_hash` parameter of `postgresql::server`.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`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.
Add sample usage for postgresql::server class. I had some issues trying to connect to the server, managed with defaults: vagrant@precise32:~$ psql psql: FATAL: role "vagrant" does not exist vagrant@precise32:~$ psql -U postgres psql: FATAL: Peer authentication failed for user "postgres" vagrant@precise32:~$ psql -U postgres -h 127.0.0.1 psql: FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL on FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL off vagrant@precise32:~$ psql -U postgres -h /var/run/postgresql psql: FATAL: Peer authentication failed for user "postgres" After some trial and error I found out that the reasons for this was restrictive permissions on the unix socket (which isn't bad at all): vagrant@precise32:~$ ls -l /var/run/postgresql/ total 4 -rw------- 1 postgres postgres 5 Oct 16 20:16 9.1-main.pid So I though I send some usage examples to help noops like myself to a quicker start with your module :-)
2012-10-16 23:24:17 +02:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`package_name`
The name of the package to use for installing the server software. Defaults to the default for your OS distro.
Update CHANGELOG, README, Modulefile for 2.0.0 release
2013-01-16 01:09:10 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`package_ensure`
Value to pass through to the `package` resource when creating the server instance. Defaults to `undef`.
Update CHANGELOG, README, Modulefile for 2.0.0 release
2013-01-16 01:09:10 +01:00
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
####`plperl_package_name`
This sets the default package name for the PL/Perl extension. Defaults to utilising the operating system default.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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.
Add support for optional management of pg_hba.conf This patch adds support for disabling management of pg_hba.conf by the module, through the parameter `manage_pg_hba_conf`.
2013-07-03 16:11:54 +02:00
Fix wrong config option
2014-04-30 11:17:47 +02:00
####`service_provider`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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.
Add globals/params layering for default_database This makes the variable consistent with the manner in which most/all of the rest of the postgresql module currently works. Commit also adds the new param to the README file.
2013-10-27 02:50:05 +02:00
####`default_database`
This setting is used to specify the name of the default database to connect with. On most systems this will be "postgres".
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`listen_addresses`
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
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).
Add sample usage for postgresql::server class. I had some issues trying to connect to the server, managed with defaults: vagrant@precise32:~$ psql psql: FATAL: role "vagrant" does not exist vagrant@precise32:~$ psql -U postgres psql: FATAL: Peer authentication failed for user "postgres" vagrant@precise32:~$ psql -U postgres -h 127.0.0.1 psql: FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL on FATAL: pg_hba.conf rejects connection for host "127.0.0.1", user "postgres", database "postgres", SSL off vagrant@precise32:~$ psql -U postgres -h /var/run/postgresql psql: FATAL: Peer authentication failed for user "postgres" After some trial and error I found out that the reasons for this was restrictive permissions on the unix socket (which isn't bad at all): vagrant@precise32:~$ ls -l /var/run/postgresql/ total 4 -rw------- 1 postgres postgres 5 Oct 16 20:16 9.1-main.pid So I though I send some usage examples to help noops like myself to a quicker start with your module :-)
2012-10-16 23:24:17 +02:00
Add support for port parameter to postgresql::server, fix underlying assumptions that port=5432
2014-04-17 21:09:07 +02:00
####`port`
Fix data directory handling The change introduced in b781849882ee5b36135f8d3abafa449721e19565 added a complex operation that was not handled correctly for all operating systems. This fix includes the following corrections: - Change the systemd config and reload systemd for datadir changes in RHEL 7, and move configuration for this into postgresql::server::config since it is managing both the PGDATA and PGPORT variables - Make sure Debian systems stop the service before changing the datadir - Recreate cert links after running initdb in Debian and early ubuntu - Change the port in the port spec to avoid selinux issues - Turn off selinux in pgdata spec to avoid selinux issues - Correct syntax for describing presence of a directory in pgdata spec - Move the pgdata spec to the end of the tests so that puppet doesn't have to manager purging and recreating the original datadir - Update README to describe all caveats of using this parameter
2014-10-31 23:27:34 +01:00
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.
Add support for port parameter to postgresql::server, fix underlying assumptions that port=5432
2014-04-17 21:09:07 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
####`ip_mask_deny_postgres_user`
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`ip_mask_allow_all_users`
serverspec + some cleanup Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-19 17:30:15 +02:00
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.
Initial commit
2012-04-20 00:37:18 +02:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`ipv4acls`
List of strings for access control for connection method, users, databases, IPv4 addresses; see [postgresql documentation](http://www.postgresql.org/docs/9.2/static/auth-pg-hba-conf.html) 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).
Initial commit
2012-04-20 00:37:18 +02:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`ipv6acls`
List of strings for access control for connection method, users, databases, IPv6 addresses; see [postgresql documentation](http://www.postgresql.org/docs/9.2/static/auth-pg-hba-conf.html) 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).
Initial commit
2012-04-20 00:37:18 +02:00
Update README.md Fixed typo "inidb_path" -> "initdb_path"
2014-01-21 14:17:16 +01:00
####`initdb_path`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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.
Create the pg_ident_rule defined type This allows us to declare user map as easilly as pg_hba entries.
2014-07-24 22:04:02 +02:00
####`pg_ident_conf_path`
Path to your `pg\_ident.conf` file.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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`
Rename contrib to server::contrib Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-20 15:35:24 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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`.
Ensure we call out the locales-all requirement.
2014-02-28 23:32:13 +01:00
#####Debian
On Debian you'll need to ensure that the 'locales-all' package is installed for full functionality of Postgres.
Add a parameter to (un)manage pg_hba.conf
2013-10-02 14:43:21 +02:00
####`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.
Create the pg_ident_rule defined type This allows us to declare user map as easilly as pg_hba entries.
2014-07-24 22:04:02 +02:00
####`manage_pg_ident_conf`
Manage pg_ident.conf by default
2014-07-30 22:55:20 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
###Class: postgresql::client
Initial commit
2012-04-20 00:37:18 +02:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
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`
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
The ensure parameter passed on to postgresql client package resource.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Rename contrib to server::contrib Signed-off-by: Ken Barber <ken@bob.sh>
2013-09-20 15:35:24 +02:00
###Class: postgresql::server::contrib
Add documentation, rspec test and support for global overriding contrib package name
2013-03-02 10:49:57 +01:00
Installs the postgresql contrib package.
####`package_name`
Fix typo, clearly from a copy/paste mistake
2014-01-17 15:47:29 +01:00
The name of the postgresql contrib package.
Add documentation, rspec test and support for global overriding contrib package name
2013-03-02 10:49:57 +01:00
####`package_ensure`
The ensure parameter passed on to postgresql contrib package resource.
add support for postgis rhel support added by @mcanevet, but the branch has been squashed. thanks!
2013-10-16 21:46:50 +02:00
###Class: postgresql::server::postgis
Installs the postgresql postgis packages.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###Class: postgresql::lib::devel
MODULES-1213 link pg_config binary into /usr/bin if not already in /usr/bin or /usr/local/bin
2014-07-14 15:59:37 +02:00
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`).
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
MODULES-1213 link pg_config binary into /usr/bin if not already in /usr/bin or /usr/local/bin
2014-07-14 15:59:37 +02:00
####`link_pg_config`
MODULES-1485 Reverted to default behavior for Debian systems as pg_config should not be overridden
2014-11-21 05:09:28 +01:00
By default on all but Debian systems, if the bin directory used by the PostgreSQL package is not `/usr/bin` or `/usr/local/bin`,
MODULES-1213 link pg_config binary into /usr/bin if not already in /usr/bin or /usr/local/bin
2014-07-14 15:59:37 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###Class: postgresql::lib::java
Add support for JDBC connector. Modify params.pp to abstract the package name for the postgresql JDBC connector and add Class['postgresql::java']. Also update the README.md to mention the availability of this class.
2013-01-21 21:52:23 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Add class postgresql::lib::perl for perl support
2014-04-02 23:52:07 +02:00
###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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###Class: postgresql::lib::python
Release 2.2.0 Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 18:21:37 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###Class: postgresql::server::plperl
Add README entry for postgresql::plperl
2013-08-12 10:14:19 +02:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###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
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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:
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
postgresql::server::db { 'test1':
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
user => 'test1',
password => 'test1',
}
####`namevar`
The namevar for the resource designates the name of the database.
Allow the ex- and import of postgresql::server::db
2014-03-26 15:05:17 +01:00
####`dbname`
The name of the database to be created. Defaults to `namevar`.
Add some missing params documentation Copy 'owner' from postgresql::server::database to postgresql::server::db and adding 'template' to both (based on the createdb man page).
2014-09-25 15:11:07 +02:00
####`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`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`user`
User to create and assign access to the database upon creation. Mandatory.
####`password`
Password for the created user. Mandatory.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`encoding`
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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`.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`tablespace`
The name of the tablespace to allocate this database to. If not specifies, it defaults to the PostgreSQL default.
Add some missing params documentation Copy 'owner' from postgresql::server::database to postgresql::server::db and adding 'template' to both (based on the createdb man page).
2014-09-25 15:11:07 +02:00
####`template`
The name of the template database from which to build this database. Defaults to `template0`.
Document istemplate parameter
2013-07-16 08:49:03 +02:00
####`istemplate`
Define database as a template. Defaults to `false`.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###Resource: postgresql::server::database
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
This defined type can be used to create a database with no users and no permissions, which is a rare use case.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`namevar`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
The name of the database to create.
####`dbname`
The name of the database, defaults to the namevar.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Update docs to reflect new `owner` parameter for `::database` type.
2013-06-06 23:50:15 +02:00
####`owner`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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`.
Update docs to reflect new `owner` parameter for `::database` type.
2013-06-06 23:50:15 +02:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`tablespace`
Tablespace for where to create this database. Defaults to the defaults defined during PostgreSQL installation.
Add some missing params documentation Copy 'owner' from postgresql::server::database to postgresql::server::db and adding 'template' to both (based on the createdb man page).
2014-09-25 15:11:07 +02:00
####`template`
The name of the template database from which to build this database. Defaults to `template0`.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`encoding`
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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.
Document istemplate parameter
2013-07-16 08:49:03 +02:00
####`istemplate`
Define database as a template. Defaults to `false`.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`namevar`
Used to uniquely identify this resource, but functionality not used during grant.
####`privilege`
Update readme
2013-07-16 21:50:44 +02:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`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`.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###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](http://www.postgresql.org/docs/8.2/static/auth-pg-hba-conf.html).
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
Update readme
2013-07-16 21:50:44 +02:00
####`namevar`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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.
Update readme
2013-07-16 21:50:44 +02:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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`.
Update readme
2013-07-16 21:50:44 +02:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`type`
The type of rule, this is usually one of: `local`, `host`, `hostssl` or `hostnossl`.
Update readme
2013-07-16 21:50:44 +02:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`database`
A comma separated list of databases that this rule matches.
Update readme
2013-07-16 21:50:44 +02:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`user`
A comma separated list of database users that this rule matches.
Update readme
2013-07-16 21:50:44 +02:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`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.
Update readme
2013-07-16 21:50:44 +02:00
Add correct documentation for pg_ident_rule type
2014-07-28 22:10:27 +02:00
###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](http://www.postgresql.org/docs/9.4/static/auth-username-maps.html).
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###Resource: postgresql::server::role
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
This resource creates a role or user in PostgreSQL.
####`namevar`
The role name to create.
####`password_hash`
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
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":
Fix documentation about username/password for the postgresql_hash function This is messed up in different ways and this commit brings it in align with what the function actually does.
2013-10-07 18:39:30 +02:00
password_hash => postgresql_password('myusername', 'mypassword'),
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
}
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`createdb`
Fixing small typos
2013-09-20 18:41:53 +02:00
Whether to grant the ability to create new databases with this role. Defaults to `false`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`createrole`
Fixing small typos
2013-09-20 18:41:53 +02:00
Whether to grant the ability to create new roles with this role. Defaults to `false`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`login`
$login parameter in server/role.pp defaults to true
2014-09-22 22:39:38 +02:00
Whether to grant login capability for the new role. Defaults to `true`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Add documentation on inherit parameter to README.md
2014-03-24 16:22:41 +01:00
####`inherit`
Whether to grant inherit capability for the new role. Defaults to `true`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`superuser`
Fixing small typos
2013-09-20 18:41:53 +02:00
Whether to grant super user capability for the new role. Defaults to `false`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Add documentation for replication flag for postgresql::role Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-25 19:46:31 +01:00
####`replication`
If `true` provides replication capabilities for this role. Defaults to `false`.
Allow to set connection limit for new role
2013-02-28 00:43:24 +01:00
####`connection_limit`
Specifies how many concurrent connections the role can make. Defaults to `-1` meaning no limit.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`username`
The username of the role to create, defaults to `namevar`.
defined type for creating database schemas This defined type helps create database schemas, and assign them to an `owner`. It is closely modeled after Postgresql::Server::Tablespace. It uses PostgreSQL's builtin IF NOT EXISTS to guarantee idempotency. (>= 9.3, else it checks pg_namespace). n.b.: This defined type *requires* that a `db` is passed. This is a concious design decision, since we find it rather useless to create such schemas in the default `postgres` database, and if *were* useful, one can always "over-specify". This addresses MODULES-1098.
2014-07-04 14:35:32 +02:00
###Resource: postgresql::server::schema
This defined type can be used to create a schema. For example:
postgresql::server::schema { 'isolated':
owner => 'jane',
db => 'janedb',
}
Fixed description for schema example The schema example referenced isolated as the namevar but in the description it said that the schema jane would be created. Fixed by updating description to say schema named isolated will be created.
2014-09-16 15:43:12 +02:00
It will create the schema `isolated` in the database `janedb` if neccessary,
defined type for creating database schemas This defined type helps create database schemas, and assign them to an `owner`. It is closely modeled after Postgresql::Server::Tablespace. It uses PostgreSQL's builtin IF NOT EXISTS to guarantee idempotency. (>= 9.3, else it checks pg_namespace). n.b.: This defined type *requires* that a `db` is passed. This is a concious design decision, since we find it rather useless to create such schemas in the default `postgres` database, and if *were* useful, one can always "over-specify". This addresses MODULES-1098.
2014-07-04 14:35:32 +02:00
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`.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
###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
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
This defined type can be used to create a tablespace. For example:
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
doc: use postgresql::*server*::tablespace in example
2014-07-04 14:47:36 +02:00
postgresql::server::tablespace { 'tablespace1':
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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.
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
####`spcname`
Name of the tablespace. Defaults to `namevar`.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
###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`
(GH-198) Fix race condition on postgresql startup This patch is a fix for the race condition that keeps occuring during postgresql setup. Its very rare on its own, but when you are using this module in a CI environment it happens quite frequently. Basically what happens is that sometimes the service will announce the database has started, but really it is still working in the background. Sometimes the unix socket may not be listening, and sometimes the system is still loading and you get a weird client error. The fix itself is a modification to postgresql::validate_db_connection so that it is able to connect on the local unix socket, plus retry until the database is available. This new and improved validate_db_connection can then be put into the build pipeline (in the service class in particular) to ensure the database is started before continuing on with the remaining steps. This in effect blocks the puppet module from continuing until the postgresql database is fully started and able to receive connections which is perfect. Tests and documentation provided. Signed-off-by: Ken Barber <ken@bob.sh>
2013-10-23 23:49:16 +02:00
The hostname of the database you wish to test. Defaults to 'undef' which generally uses the designated local unix socket.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`database_port`
(GH-198) Fix race condition on postgresql startup This patch is a fix for the race condition that keeps occuring during postgresql setup. Its very rare on its own, but when you are using this module in a CI environment it happens quite frequently. Basically what happens is that sometimes the service will announce the database has started, but really it is still working in the background. Sometimes the unix socket may not be listening, and sometimes the system is still loading and you get a weird client error. The fix itself is a modification to postgresql::validate_db_connection so that it is able to connect on the local unix socket, plus retry until the database is available. This new and improved validate_db_connection can then be put into the build pipeline (in the service class in particular) to ensure the database is started before continuing on with the remaining steps. This in effect blocks the puppet module from continuing until the postgresql database is fully started and able to receive connections which is perfect. Tests and documentation provided. Signed-off-by: Ken Barber <ken@bob.sh>
2013-10-23 23:49:16 +02:00
Port to use when connecting. Default to 'undef' which generally defaults to 5432 depending on your PostgreSQL packaging.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`database_name`
(GH-198) Fix race condition on postgresql startup This patch is a fix for the race condition that keeps occuring during postgresql setup. Its very rare on its own, but when you are using this module in a CI environment it happens quite frequently. Basically what happens is that sometimes the service will announce the database has started, but really it is still working in the background. Sometimes the unix socket may not be listening, and sometimes the system is still loading and you get a weird client error. The fix itself is a modification to postgresql::validate_db_connection so that it is able to connect on the local unix socket, plus retry until the database is available. This new and improved validate_db_connection can then be put into the build pipeline (in the service class in particular) to ensure the database is started before continuing on with the remaining steps. This in effect blocks the puppet module from continuing until the postgresql database is fully started and able to receive connections which is perfect. Tests and documentation provided. Signed-off-by: Ken Barber <ken@bob.sh>
2013-10-23 23:49:16 +02:00
The name of the database you wish to test. Defaults to 'postgres'.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`database_username`
(GH-198) Fix race condition on postgresql startup This patch is a fix for the race condition that keeps occuring during postgresql setup. Its very rare on its own, but when you are using this module in a CI environment it happens quite frequently. Basically what happens is that sometimes the service will announce the database has started, but really it is still working in the background. Sometimes the unix socket may not be listening, and sometimes the system is still loading and you get a weird client error. The fix itself is a modification to postgresql::validate_db_connection so that it is able to connect on the local unix socket, plus retry until the database is available. This new and improved validate_db_connection can then be put into the build pipeline (in the service class in particular) to ensure the database is started before continuing on with the remaining steps. This in effect blocks the puppet module from continuing until the postgresql database is fully started and able to receive connections which is perfect. Tests and documentation provided. Signed-off-by: Ken Barber <ken@bob.sh>
2013-10-23 23:49:16 +02:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
####`database_password`
Release 2.2.0 Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 18:21:37 +02:00
Password to connect with. Can be left blank, but that is not recommended.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
(GH-198) Fix race condition on postgresql startup This patch is a fix for the race condition that keeps occuring during postgresql setup. Its very rare on its own, but when you are using this module in a CI environment it happens quite frequently. Basically what happens is that sometimes the service will announce the database has started, but really it is still working in the background. Sometimes the unix socket may not be listening, and sometimes the system is still loading and you get a weird client error. The fix itself is a modification to postgresql::validate_db_connection so that it is able to connect on the local unix socket, plus retry until the database is available. This new and improved validate_db_connection can then be put into the build pipeline (in the service class in particular) to ensure the database is started before continuing on with the remaining steps. This in effect blocks the puppet module from continuing until the postgresql database is fully started and able to receive connections which is perfect. Tests and documentation provided. Signed-off-by: Ken Barber <ken@bob.sh>
2013-10-23 23:49:16 +02:00
####`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`.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
###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:
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
$ puppet apply --execute 'notify { "test": message => postgresql_password("username", "password") }'
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
###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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
**This function should only be used internally by the module**.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Limitations
------------
Fixed typos, rewording and typsetting per feedback Updated spelling errors, typsetting issues and some wording suggestions based on module author feedback
2013-01-23 00:16:21 +01:00
Works with versions of PostgreSQL from 8.1 through 9.2.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Current it is only actively tested with the following operating systems:
* Debian 6.x and 7.x
Add `service_ensure`. This allows you to control the status of the Postgresql service directly from postgresql::server.
2014-05-08 22:43:22 +02:00
* Centos 5.x, 6.x, and 7.x.
* Ubuntu 10.04 and 12.04, 14.04
Major rewrite to solve order dependencies and unclear public API This is a very very large change to the module. It started out as a fix to add postgresl::server::config_entry, and quickly became a rewrite to fix a lot of ordering issues inherent in the API. Since this changes the Public API it is considered a backwards compatible change. See the upgrading guide in README.md for more details as to what has been modified in this patch. Signed-off-by: Ken Barber <ken@bob.sh>
2013-08-27 22:43:47 +02:00
Although patches are welcome for making it work with other OS distros, it is considered best effort.
Merge 3.4.x changes into master.
2014-07-25 15:31:00 +02:00
### Postgis support
Postgis is currently considered an unsupported feature as it doesn't work on
all platforms correctly.
Add workaround for selinux.
2014-06-24 17:11:03 +02:00
### 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
```
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Development
Initial commit
2012-04-20 00:37:18 +02:00
------------
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
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.
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
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.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
### Tests
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
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:
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
* rake
* bundler
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
Install the necessary gems:
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
bundle install --path=vendor
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
And then run the unit tests:
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
bundle exec rake spec
Add a few more docs about running system tests
2013-05-06 19:50:03 +02:00
Fix some typo's in Readme and specfile.
2014-09-12 15:03:39 +02:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
If you want to run the system tests, make sure you also have:
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
* vagrant > 1.2.x
* Virtualbox > 4.2.10
Add a few more docs about running system tests
2013-05-06 19:50:03 +02:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
Then run the tests using:
Add a few more docs about running system tests
2013-05-06 19:50:03 +02:00
Fix how to run the acceptance tests
2014-04-24 22:10:18 +02:00
bundle exec rspec spec/acceptance
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Convert system tests to use rspec-system This patch ports all of the existing system tests to use rspec-system instead. To assist with this conversion some patches were made to fix OS compatibility where necessary. We also added an ensure parameter to the postgresql::server class to assist with removing PostgreSQL configuration to aid with testing cleanups. The documentation has been updated to indicate test usage with rspec-system, we've also renamed the 'tests' directory to 'examples'. Signed-off-by: Ken Barber <ken@bob.sh>
2013-04-26 17:35:09 +02:00
To run the tests on different operating systems, see the sets available in .nodeset.yml and run the specific set with the following syntax:
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Fix how to run the acceptance tests
2014-04-24 22:10:18 +02:00
RSPEC_SET=debian-607-x64 bundle exec rspec spec/acceptance
Provide new defined resources for managing pg_hba.conf This patch provides a more advanced way of managing pg_hba rules, by providing a defined resource to manage a pg_hba file, and a defined resource for managing rules within such a file (pg_hba_rule). These new resources are wrappers around ripinaar-concat, and utilise file assemblies instead of a template to compose the pg_hba.conf file. I've provided a function that interprets the old ip4|6acl arrays and converts them to this new format for backwards compatibility as well. I slightly reformatted our documentation to allow for better documentation of defined resources in 'Usage' as well, and provided examples of how to use this new resource. This hopefully should go a long way to solving the PR's related to lack of full functionality for pg_hba.conf. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-10 01:36:12 +01:00
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
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.
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Previously: [https://github.com/inkling/puppet-postgresql](https://github.com/inkling/puppet-postgresql)
Updated content to conform to README best practices template Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub and the Module of the Week blog post. A table of contents was added for navigability, standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent and pulled-in content was moved under its appropriate heading and edited for tone/flow/clarity, links to outside documentation were updated, and basic formatting was done to adhere to template standards.
2013-01-19 01:17:08 +01:00
Contributors
------------
Fix module file, remove extra README.md and fix some docs The module file had the wrong revision in it for starters. And there was some missing items from the .gitignore. The extra README.md in spec/system was getting extracted as the main README on the forge so I remove it, moving the content that was not duplicated already into README.md. I took the opportunity also to finish the documentation in the Reference section of the README to make sure all classes and defined resources are documented. Signed-off-by: Ken Barber <ken@bob.sh>
2013-02-20 13:45:21 +01:00
Initial commit
2012-04-20 00:37:18 +02:00
* Andrew Moon
* [Kenn Knowles](https://github.com/kennknowles) ([@kennknowles](https://twitter.com/KennKnowles))
Update CHANGELOG, README, Modulefile for 2.0.0 release
2013-01-16 01:09:10 +01:00
* Adrien Thebo
* Albert Koch
* Andreas Ntaflos
Special case for $datadir on Amazon Closes #252
2013-10-02 21:38:20 +02:00
* Bret Comnes
Update CHANGELOG, README, Modulefile for 2.0.0 release
2013-01-16 01:09:10 +01:00
* 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
Reference in a new issue Copy permalink