/ansible-postgresql-role

Ansible role to install, configure and administrate Postgresql clusters

Primary LanguageJinjaMIT LicenseMIT

PostgreSQL Ansible role Build Status

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

Installation

This role has been tested on Ansible 2.3.0 and higher.

To install:

ansible-galaxy install trainline-eu.postgresql

Dependencies

No dependencies

Recommended dependencies:

  • trainline-eu.barman

Compatibility matrix

This table lists the tested version of OS/PostgreSQL couples.

Distribution / PostgreSQL 9.1 9.4 9.5 9.6 10 11
Debian 8.x ⛔ ✅ ✅ ✅ ✅ ✅ ❔
Debian 9.x ⛔ ✅ ✅ ✅ ✅ ✅ ❔
  • ✅ - tested, works fine
  • ❔ - will work in the future (help out if you can)
  • ⁉️ - maybe works, not tested
  • ⛔ - PostgreSQL has reached EOL

Variables

# Basic settings
postgres_listen_addresses: [ '127.0.0.1' ] # Optional
postgres_log_dir: '/home/postgres-logs'    # Optional
postgres_data_dir: '/home/postgres'        # Optional
postgres_clusters:                         # Mandatory
  - version: 10                              # Mandatory
    name: 'main'                             # Mandatory
    port: 5432                               # Mandatory
    checksums: True                          # Optional
    fsync_enabled: False                     # Optional
    archive_enabled: False                   # Optional
    # List of users to be created (optional)
    users:
      - username: 'replicator'                 # Mandatory
        password: 'SuperSecret'                # Mandatory
        permissions: 'REPLICATION'             # Mandatory
    # List of databases to be created (optional)
    databases:
      - dbname: my_database                    # Mandatory
        owner: john                            # Mandatory

# Postgres config (Optional)
postgres_log_line_prefix: '%m [%p] database: %d host: %h user: %u '
postgres_datestyle: 'iso, dmy'
postgres_locale_formats: fr_FR.UTF-8
postgres_text_search_config: pg_catalog.french

# Postgres pg_hba config (optional)
postgres_allowed_hosts:
  - user: all
    range: 10.0.0.0/24
postgres_replication_hosts:
  - user: replicator
    range: 10.0.0.0/24

Testing

This project comes with a test/main.yml testing playbook. It uses Docker to provision containers locally and sets up a 3 node postgresql cluster with a barman server.

Coverage of this playbook is probably not complete but at least it's there.

If you are contributing, please first test your changes in a new playbook in the test/ directory within docker containers, (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

Creators:

Maintainers:

Feedback, bug-reports, requests, ...

Are welcome!