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
   $ docker build -t tpa/tpaexec .

Double-check the created image:

.. code:: bash

   $ docker image ls tpa/tpaexec
   REPOSITORY    TAG       IMAGE ID       CREATED         SIZE
   tpa/tpaexec   latest    e145cf8276fb   8 seconds ago   1.73GB
   $ docker run --platform=linux/amd64 --rm tpa/tpaexec tpaexec info

   #  TPAexec v20.11-59-g85a62fe3 (branch: master)

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

Create a TPA container and make your cluster configuration directories
available inside the container:

.. code:: bash

   $ docker run --platform=linux/amd64 --rm -v ~/clusters:/clusters \
       -it tpa/tpaexec:latest

You can now run commands like ``tpaexec provision /clusters/speedy`` at
the container prompt. (When you exit the shell, the container will be
removed.)

If you want to provision Docker containers using TPA, you must also
allow the container to access the Docker control socket on the host:

::

   $ docker run --platform=linux/amd64 --rm -v ~/clusters:/clusters \
       -v /var/run/docker.sock:/var/run/docker.sock \
       -it tpa/tpaexec:latest

Run ``docker ps`` within the container to make sure that your connection
to the host Docker daemon is working.

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.