Running TPA in a Docker container
=================================

If you are using a system for which there are no :ref:`TPA installation <TPA installation>` 
available, and it’s difficult to run TPA after :ref:`Installing TPA from source <Installing TPA from source>`  (for
example, because it’s not easy to obtain a working Python 3.12+
interpreter), your last resort may be to build a Docker image and run
TPA inside a Docker container.

Please note that you do not need to run TPA in a Docker container in
order to :ref:`Installing Docker <Installing Docker>`  . It’s always preferable to run TPA directly if
you can (even on MacOS X).

Quickstart
----------

You must have Docker installed and working on your system already.

Run the following commands to clone the tpaexec source repository from
Github and build a new Docker image named ``tpa/tpaexec`` :

.. code:: bash

   $ git clone ssh://git@github.com/EnterpriseDB/tpa.git
   $ cd tpa
   $ docker build -f docker/Dockerfile --build-arg TPA_VER=$(git describe) -t tpaexec:latest .

Double-check the created image:

.. code:: bash

   $ docker image ls tpaexec
   REPOSITORY   TAG       IMAGE ID       CREATED          SIZE
   tpaexec      latest    3943dec4d660   20 minutes ago   658MB

   $ docker run --rm tpaexec info

   #  TPAexec v23.38.0-38-g4dc030dc1

   tpaexec=/usr/local/bin/tpaexec
   TPA_DIR=/opt/EDB/TPA
   PYTHON=/opt/EDB/TPA/tpa-venv/bin/python3 (v3.13.5, venv)
   TPA_VENV=/opt/EDB/TPA/tpa-venv
   ANSIBLE=/opt/EDB/TPA/tpa-venv/bin/ansible (v2.16.14)

Then you need to setup an alias for ``tpaexec`` on the shell session you
are running:

::

   alias tpaexec="docker run --rm -v $PWD:/work -v /var/run/docker.sock:/var/run/docker.sock tpaexec"

Now you can run commands like:

::

   $ tpaexec configure cluster -a M1 --postgresql 15 --failover-manager patroni --platform docker
   $ tpaexec deploy cluster

Installing Docker
-----------------

Please consult the `Docker documentation <https://docs.docker.com>`_  if you need help to `install Docker <https://docs.docker.com/install>`_  and
`get started <https://docs.docker.com/get-started/>`_  with it.

On MacOS X, you can `install "Docker Desktop forMac" <https://hub.docker.com/editions/community/docker-ce-desktop-mac/>`_ 

and launch Docker from the application menu.