TCRD-Docker

This repository contains code for constructing the docker image of TCRD (Target Central Resource Database).

At the time of writing the DB platform used is mysql.

Note that the code within this repository relies on an existing dump of the TCRD database. For the TCRD source code please see:

• https://github.com/unmtransinfo/TCRD
• https://github.com/unmtransinfo/TCRDpy3

Prerequisites

• Docker
• At least 140GB of free storage space
• (Recommended) at least 32GB of RAM

Usage

1. Copy .env.example to .env and edit values to match your environment:

   cp .env.example .env

   Variable	Description
   CPUS	CPU cores allocated to the container (decimals accepted, e.g. 4.5)
   MEMORY	RAM allocated to the container — suffix must be G or M (e.g. 32G)
   MYSQL_ROOT_PASSWORD	Root password for the MySQL instance
   MYSQL_DATABASE	Name of the database to create and restore into
   DB_USER	Read-only user created after restore
   DB_PASSWORD	Password for the read-only user
   HOST_PORT	Host port mapped to MySQL's container port 3306

2. Run tune.sh to generate a MySQL configuration file based on your resources params (CPUS and MEMORY)

3. Run docker compose:

   docker compose up -d

   One can track the progress of the restore with:

   docker compose logs -f

   The DB will take some time to restore, it takes about 10 hours using CPUS=8 and MEMORY=128G (vanilla mysql restore is very slow).

   The container will be ready to use once you see a message like the following:

   [Server] /usr/sbin/mysqld: ready for connections.

4. After the DB restore/initialization is complete one can connect to the database like so from the host:

   # use DB_PASSWORD when prompted for password
   mysql -D tcrd -u <DB_USER> -P <HOST_PORT> -h 127.0.0.1 -p