Makefile

This document covers all build targets available in the Tator Makefile. To use them, issue a shell command preceded by make:

make TARGET

Docker compose

Target	Description
`cluster`	Builds docker images, installs dependencies and installs compose deployment.
`cluster-uninstall`	Uninstalls compose deployment.
`cluster-install`	Installs compose deployment.
`cluster-update`	Applies changes to Docker compose configuration (defined in `.env`).
`cluster-upgrade`	Builds docker images and updates compose deployment to use latest images and configuration.
`tator`	Alias for `cluster-install`.
`clean`	Alias for `cluster-uninstall`.

Target	Description
`images`	Builds and pushes all Docker images.
`tator-image`	Builds and pushes Tator backend image.
`client-image`	Builds and pushes Tator client image.
`postgis-image`	Builds and pushes PostgreSQL image with PostGIS extension.
`ui-image`	Builds and pushes Tator UI image.

Target	Description
`gunicorn-bash`	Starts shell in Gunicorn container.
`gunicorn-logs`	Streams logs from Gunicorn container.
`gunicorn-reset`	Restarts Gunicorn service.
`nginx-bash`	Starts shell in NGINX container.
`nginx-logs`	Streams logs from NGINX container.
`nginx-reset`	Restarts NGINX service.
`redis-bash`	Starts shell in Redis container.
`redis-logs`	Streams logs from Redis container.
`redis-reset`	Restarts Redis service.
`ui-bash`	Starts shell in UI container.
`ui-logs`	Streams logs from UI container.
`ui-reset`	Restarts UI service.
`postgis-bash`	Starts shell in PostgreSQL container.
`postgis-logs`	Streams logs from PostgreSQL container.
`postgis-reset`	Restarts PostgreSQL service.
`minio-bash`	Starts shell in min.io container.
`minio-logs`	Streams logs from min.io container.
`minio-reset`	Restarts min.io service.
`transcode-bash`	Starts shell in transcode container.
`transcode-logs`	Streams logs from transcode container.
`transcode-reset`	Restarts transcode service.
`transcode-worker-bash`	Starts shell in transcode worker container.
`transcode-worker-logs`	Streams logs from transcode worker container.
`transcode-worker-reset`	Restarts transcode worker service.
`status`	Running status of all existing Kubernetes pods.
`rq-info`	Display asynchronous DB and image worker jobs that are queued.
`cleanup-evicted`	Deletes all Kubernetes pods with status `Evicted`.
`announce`	Create a system announcement. Requires definition of `FILE` and optionally `USER_ID` or `PROJECT_ID` for limiting scope. See tutorial for examples.

Target	Description
`backup`	Uses the `pg_dump` utility to create a backup of the PostgreSQL database.
`restore`	Restores a database backup. Requires definition of `SQL_FILE` and `DB_NAME`, e.g. `make restore SQL_FILE=tator_online_2022_01_25__06_40_05_86964b646709fd2581583413383e89570b37b1d5.sql DB_NAME=tator_online`. To see a list of existing backups, use `make gunicorn-bash` followed by `ls /backup`.
`migrate`	Apply PSQL database migrations associated with source in `main/models.py` in first Gunicorn container found.

Target	Description
python-bindings	Builds Tator image and Tator Python client.
python-bindings-only	Builds Python client using existing generated code.
js-bindings	Builds Tator JavaScript client.

Target	Description
`dev-push`	Copies all files to Gunicorn containers. Gunicorn will automatically restart when changes are detected.
`collect-static`	Builds webpack bundles and copies static content to first existing Gunicorn container found.
`django-shell`	Starts Django shell in first existing Gunicorn container found.
`webpack`	Builds webpack bundles.
`testinit`	Sets up first time run of REST unit tests.
`test`	Runs REST unit tests.
`pytest`	Runs tator-py unit tests.