Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

Latest commit

 

History

History
200 lines (148 loc) · 8.46 KB

README.md

File metadata and controls

200 lines (148 loc) · 8.46 KB
Raw

setup_replication

This Ansible Galaxy Role configures Replication on PostgresSQL or EnterpriseDB Postgres Advanced Server versions: 10, 11, 12, 13, 14 and 15 on instances previously configured.

Requirements

The requirements for this ansible galaxy role are:

  1. Ansible
  2. community.general - utilized when creating aditional users during a Postgres Install. Only on primary nodes.
  3. edb_devops.edb_postgres -> setup_repo - for repository installation
  4. edb_devops.edb_postgres -> install_dbserver - for installation of PostgreSQL/EPAS binaries.
  5. edb_devops.edb_postgres -> init_dbserver - for the initialization of primary server

Role variables

When executing the role via ansible there are three required variables:

  • os

Operating Systems supported are: CentOS7, CentOS8, RHEL7, RHEL8, Rocky8, AlmaLinux8, Debian9, Debian10, Ubuntu20, and Ubuntu22

  • pg_version

Postgres Versions supported are: 10, 11, 12, 13, 14 and 15

  • pg_type

Database Engine supported are: PG and EPAS

With above two variables, role has the following optional variables to enable Transparent Data Encryption (TDE) for EPAS versions 15.0 and above:

  • edb_enable_tde

Supported value is true or false. This variable informs roles to execute specific tasks related Enable TDE

  • edb_key_unwrap_cmd

Unwrap commad to decrypt EDB master key. User can also pass KMS using the above parameter to EPAS for using master key for encryption. For more information, please refer to EPAS guide on TDE. This parameter used by EDB during starting the Postgres service.

  • edb_key_wrap_cmd

Wrap command to encrypt EDB master key. User can also use KMS commands to get the key and encrypt the master key to store in EPAS.

  • edb_master_key

This is an optional key master key parameter. Using this parameter user can pass a master key. If you don't want to use this parameter then pass radom string and ensure that your edb_key_unwrap_cmd and edb_key_wrap_cmd commands can get the right key from known KMS.

  • edb_secure_master_key

This is an option key for encrypting edb_master_key to keep it secure in EPAS. User can skip edb_master_key and edb_secure_master_key both by ensuring that edb_key_unwrap_cmd_ and edb_key_wrap_cmd commands can get the right key from known KMS.

The rest of the variables can be configured and are available in the:

Dependencies

The setup_replication role does not have any dependencies on any other roles.

Example Playbook

Hosts file content

Content of the inventory.yml file:

---
all:
  children:
    primary:
      hosts:
        primary1:
          ansible_host: xxx.xxx.xxx.xxx
          private_ip: xxx.xxx.xxx.xxx
    standby:
      hosts:
        standby1:
          ansible_host: xxx.xxx.xxx.xxx
          private_ip: xxx.xxx.xxx.xxx
          upstream_node_private_ip: xxx.xxx.xxx.xxx
          replication_type: synchronous
        standby2:
          ansible_host: xxx.xxx.xxx.xxx
          private_ip: xxx.xxx.xxx.xxx
          upstream_node_private_ip: xxx.xxx.xxx.xxx
          replication_type: asynchronous

How to include the setup_replication role in your Playbook

Below is an example of how to include the setup_replication role:

---
- hosts: standby
  name: Setup Postgres replication on Instances
  become: true
  gather_facts: true
  any_errors_fatal: true

  collections:
    - edb_devops.edb_postgres

  pre_tasks:
    - name: Initialize the user defined variables
      set_fact:
        pg_version: 14
        pg_type: "PG"

  roles:
    - role: setup_repo
      when: "'setup_repo' in lookup('edb_devops.edb_postgres.supported_roles', wantlist=True)"
    - role: install_dbserver
      when: "'install_dbserver' in lookup('edb_devops.edb_postgres.supported_roles', wantlist=True)"
    - role: setup_replication
      when: "'setup_replication' in lookup('edb_devops.edb_postgres.supported_roles', wantlist=True)"

Defining and adding variables is done in the set_fact of the pre_tasks.

All the variables are available at:

Database engines supported

Community PostgreSQL

Distribution 10 11 12 13 14 15
CentOS 7 ✅ ✅ ✅ ✅ ✅ ✅
Red Hat Linux 7 ✅ ✅ ✅ ✅ ✅ ✅
RockyLinux 8 ✅ ✅ ✅ ✅ ✅ ✅
Red Hat Linux 8 ✅ ✅ ✅ ✅ ✅ ✅
AlmaLinux8 ✅ ✅ ✅ ✅ ✅ ✅
Ubuntu 20.04 LTS (Focal) - x86_64 ✅ ✅ ✅ ✅ ✅ ✅
Debian 9 (Stretch) - x86_64 ✅ ✅ ✅ ✅ ✅ ✅
Debian 10 (Buster) - x86_64 ✅ ✅ ✅ ✅ ✅ ✅

EnterpriseDB Postgres Advanced Server and PEM

Distribution 10 11 12 13 14 15
CentOS 7 ✅ ✅ ✅ ✅ ✅ ✅
Red Hat Linux 7 ✅ ✅ ✅ ✅ ✅ ✅
RockyLinux 8 ❌ ❌ ✅ ✅ ✅ ✅
Red Hat Linux 8 ❌ ❌ ✅ ✅ ✅ ✅
AlmaLinux8 ❌ ❌ ✅ ✅ ✅ ✅
Ubuntu 20.04 LTS (Focal) - x86_64 ❌ ❌ ❌ ✅ ✅ ✅
Debian 9 (Stretch) - x86_64 ❌ ✅ ✅ ✅ ✅ ✅
Debian 10 (Buster) - x86_64 ❌ ❌ ✅ ✅ ✅ ✅

Playbook execution examples

# To deploy community Postgres version 13 on CentOS7 hosts with the user centos
# EFM version 4.0
$ ansible-playbook playbook.yml \
  -u centos \
  -i inventory.yml \
  --private-key <key.pem> \
  --extra-vars="pg_version=13 pg_type=PG efm_version=4.0"
# To deploy EPAS version 12 on RHEL8 hosts with the user ec2-user EFM version
# 3.10
$ ansible-playbook playbook.yml \
  -u ec2-user \
  -i inventory.yml \
  --private-key <key.pem> \
  --extra-vars="os=RHEL8 pg_version=12 pg_type=EPAS efm_version=3.10"

License

BSD

Author information

Author: