PGD-S
=====

!!!Note

This architecture is for Postgres Distributed 6 only. If you require PGD
5 please use :ref:`PGD-Always-ON <PGD-Always-ON>`  .

.. ::
   EDB Postgres Distributed 6 in a PGD Essential (PGD-S) configuration suitable for use in test and production.

This architecture requires an EDB subscription. All software is sourced
from :ref:`Configuring EDB Repos 2.0 repositories <Configuring EDB Repos 2.0 repositories>`  .

Cluster configuration
---------------------

Overview of configuration options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

An example invocation of ``tpaexec configure`` for this architecture is
shown below.

.. code:: bash

   tpaexec configure ~/clusters/pgd-s \
       --architecture PGD-S
       --edb-postgres-extended 15 \
       --platform aws --instance-type t3.micro \
       --distribution Debian \

You can list all available options using the help command.

.. code:: bash

   tpaexec configure --architecture PGD-S --help

The table below describes the mandatory options for PGD-S and additional
important options. More detail on the options is provided in the
following section.

Mandatory Options
^^^^^^^^^^^^^^^^^

.. csv-table::
  :header: Options,Description
  :widths: 10,30
  :align: left
  :class: longtable

  `--architecture` (`-a`),Must be set to `PGD-S`
  Postgres flavour and version (e.g. `--postgresql 15`),A valid  :ref:`Postgres flavour and version<Postgres flavour and version>` .

Additional Options
^^^^^^^^^^^^^^^^^^

.. csv-table::
  :header: Options,Description,Behaviour if omitted
  :widths: 12,25,15
  :align: left
  :class: longtable

  `--platform`,"One of `aws`, `docker`, `bare`.",Defaults to `aws`.
  `--bdr-database`,The name of the database to be used for replication.,Defaults to `bdrdb`.

More detail about PGD-S configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A PGD-S cluster comprises a single location with three data nodes.

You may optionally specify ``--bdr-database dbname`` to set the name of
the database with BDR enabled (default: bdrdb).

You may optionally specify ``--enable-pgd-probes [{http, https}]`` to
enable http(s) api endpoints that will allow to easily probe proxy’s
health.

You may also specify any of the options described by :ref:`Cluster configuration <Cluster configuration>`  .
