ANXS - PostgreSQL

---

Help Wanted! If you are able and willing to help maintain this Ansible role then please open a GitHub issue. A lot of people seem to use this role and we (quite obviously) need assistance! 💖

Ansible role which installs and configures PostgreSQL, extensions, databases and users.

Installation

This has been tested on Ansible 2.4.0 and higher.

To install:

ansible-galaxy install ANXS.postgresql

Example Playbook

Including an example of how to use your role:

- hosts: postgresql-server
  become: yes
  roles:
     - { role: anxs.postgresql }

Dependencies

• ANXS.monit (Galaxy/GH) if you want monit protection (in that case, you should set monit_protection: true)

Compatibility matrix

Distribution / PostgreSQL	<= 9.3	9.4	9.5	9.6	10	11	12
Ubuntu 14.04	⛔	⛔	⛔	⛔	⛔	⛔	⛔
Ubuntu 16.04	⛔	✅	✅	✅	✅	✅	✅
Debian 8.x	⛔	✅	✅	✅	✅	✅	✅
Debian 9.x	⛔	✅	✅	✅	✅	✅	✅
CentOS 6.x	⛔	✅	✅	✅	✅	✅	✅
CentOS 7.x	⛔	✅	✅	✅	✅	✅	✅
CentOS 8.x	⛔	❔	❔	❔	❔	❔	❔
Fedora latest	⛔	❌	❌	❌	❌	❌	❌

• ✅ - tested, works fine
• ⚠️ - Not for production use
• ❔ - will work in the future (help out if you can)
• ⁉️ - maybe works, not tested
• ⛔ - Has reached End of Life (EOL)

Variables

# Basic settings
postgresql_version: 12
postgresql_encoding: "UTF-8"
postgresql_locale: "en_US.UTF-8"
postgresql_ctype: "en_US.UTF-8"

postgresql_admin_user: "postgres"
postgresql_default_auth_method: "peer"

postgresql_service_enabled: false # should the service be enabled, default is true

postgresql_cluster_name: "main"
postgresql_cluster_reset: false

# List of databases to be created (optional)
# Note: for more flexibility with extensions use the postgresql_database_extensions setting.
postgresql_databases:
  - name: foobar
    owner: baz          # optional; specify the owner of the database
    hstore: yes         # flag to install the hstore extension on this database (yes/no)
    uuid_ossp: yes      # flag to install the uuid-ossp extension on this database (yes/no)
    citext: yes         # flag to install the citext extension on this database (yes/no)
    encoding: "UTF-8"   # override global {{ postgresql_encoding }} variable per database
    lc_collate: "en_GB.UTF-8"   # override global {{ postgresql_locale }} variable per database
    lc_ctype: "en_GB.UTF-8"     # override global {{ postgresql_ctype }} variable per database

# List of database extensions to be created (optional)
postgresql_database_extensions:
  - db: foobar
    extensions:
      - hstore
      - citext

# List of users to be created (optional)
postgresql_users:
  - name: baz
    pass: pass
    encrypted: yes  # if password should be encrypted, postgresql >= 10 does only accepts encrypted passwords

# List of schemas to be created (optional)
postgresql_database_schemas:
  - database: foobar           # database name
    schema: acme               # schema name
    state: present

  - database: foobar           # database name
    schema: acme_baz           # schema name
    owner: baz                 # owner name
    state: present

# List of user privileges to be applied (optional)
postgresql_user_privileges:
  - name: baz                   # user name
    schema: foobar              # schema
    objs: ALL_IN_SCHEMA         # objects to be applied for
    privs: "SELECT"             # privileges

There's a lot more knobs and bolts to set, which you can find in the defaults/main.yml

Fork additions

• Add pg_stat_statements variables, if pg_stat_statement in preload libraries;
• Add role_attr_flags to postgresql_users for create users with some attrs e.g. SUPERUSER;
• Add postgresql_all_databases_schema variable to create one schema in all databases from postgresql_databases;
• Updating user privileges now using postgresql_privs ansible module. Example:

postgresql_user_privileges:
  - name: readonly_user
    type: schema
    objs: dbo
    privs: "USAGE"
  - name: readonly_user
    schema: dbo
    objs: ALL_IN_SCHEMA
    privs: "SELECT"

Testing

This project comes with a Vagrantfile, this is a fast and easy way to test changes to the role, fire it up with vagrant up

See vagrant docs for getting setup with vagrant

Once your VM is up, you can reprovision it using either vagrant provision, or ansible-playbook tests/playbook.yml -i vagrant-inventory

If you want to toy with the test play, see tests/playbook.yml, and change the variables in tests/vars.yml

If you are contributing, please first test your changes within the vagrant environment, (using the targeted distribution), and if possible, ensure your change is covered in the tests found in .travis.yml

License

Licensed under the MIT License. See the LICENSE file for details.

Thanks

Creator:

• Pjan Vandaele

Maintainers:

• Jonathan Lozada D.
• Jonathan Freedman
• Sergei Antipov
• Greg Clough

Top Contributors:

• David Farrington

• Jesse Lang

• Michael Conrad

• Sébastien Alix

• Copperfield

• Ralph von der Heyden

Feedback, bug-reports, requests, ...

Are welcome!