This repository is for hosting an Ansible Galaxy Collection tmax_opensql.postgres which helps users easily deploy Tmax OpenSQL package for PostgreSQL.

The ansible playbook must be executed under an account that has full privileges.

The following table describes the roles included in tmax_opensql.postgres collection.

For correctly installed and configuration of the cluster following are requirements:

1. Ansible (on the machine on which playbook will be executed).
2. Operating system privileged user (user with sudo privilege) on all the servers/virtual machines.
3. Machines for the Postgres cluster should have at least 2 CPUs and 4 GB of RAM
4. The machine utilized for deploying with ansible can be a minimal instance

To install Ansible: Installing Ansible

tmax_opensql.postgres can be installed in the following approaches:

Use the command below to install tmax_opensql.postgres:

ansible-galaxy collection install tmax_opensql.postgres --force

This approach automatically makes the tmax_opensql.postgres collection available to your playbooks.

A message indicating where the collection is installed will be displayed by ansible-galaxy. The collection code should be automatically made readily available for you.

By default the location of your installed collection is: ~/.ansible/collections/ansible_collections

Use the command below to install tmax_opensql.postgres:

git clone https://github.com/tmaxopensql/pg-ansible.git
cd pg-ansible
make install

This approach automatically makes the tmax_opensql.postgres collection available to your playbooks.

A message indicating where the collection is installed will be displayed by ansible-galaxy. The collection code should be automatically made readily available for you.

By default the location of your installed collection is: ~/.ansible/collections/ansible_collections

Content of the inventory.yml file:

---
all:
  children:
    primary:
      hosts:
        primary1:
          ansible_host: 110.0.0.1
          private_ip: 10.0.0.1
    standby:
      hosts:
        standby1:
          ansible_host: 110.0.0.2
          private_ip: 10.0.0.2
          upstream_node_private_ip: 10.0.0.1
          replication_type: synchronous
        standby2:
          ansible_host: 110.0.0.3
          private_ip: 10.0.0.3
          upstream_node_private_ip: 10.0.0.1
          replication_type: asynchronous

Note: don't forget to replace IP addresses.

Below is an example of how to include all the roles for a deployment in a playbook:

---
- hosts: all
  name: Postgres deployment playbook
  become: yes
  gather_facts: yes

  collections:
    - tmax_opensql.postgres

  pre_tasks:
    - name: Initialize the user defined variables
      set_fact:
        pg_version: 14.6
        pg_type: "PG"
        disable_logging: false

  roles:
    - role: setup_repo
    - role: install_dbserver
    - role: init_dbserver
    - role: setup_extension
    - role: setup_replication
    - role: setup_pgpool2
    - role: manage_pgpool2
    - role: manage_dbserver
    - role: setup_pgbackrest
    - role: setup_pgbackrestserver
    - role: setup_pgbouncer
    - role: manage_pgbouncer
    - role: setup_barmanserver
    - role: manage_barmanbackup
    - role: autotuning

You can customize the above example to install Tmax OpenSQL Package by selecting which roles you would like to execute.

The following will occur should a password not be provided for the following accounts:

• pg_superuser
• pg_replication_user

Note:

• The ~/.pgpassfile folder and contained files are secured by assigning the permissions to user executing the playbook.
• The naming convention for the password file is: <username>_pass

Examples of utilizing the playbooks for installing Tmax OpenSQL Package are provided and located within the playbook-examples directory.

When using non standard SSH port (different from 22), the port value must be set in two places:

• in the inventory file, for each host, with the host var. ansible_port
• in the playbook or variable file with the variable ssh_port

# To deploy community Postgres version 14.6
ansible-playbook playbook.yml \
  -i inventory.yml \
  -u <ssh-user> \
  --private-key <ssh-private-key> \
  --extra-vars="pg_version=14.6 pg_type=PG"

• CentOS7
• CentOS8
• Rocky8
• Rocky9

• 14.0 - 14.8
• 15.0 - 15.3

Tmax OpenSQL v2.0

BSD

Authors:

• Sung Woo Chang
• Sang Myeung Lee