T3/Breedbase Docker Image

This repo contains the Dockerfile for building the T3 version of breedbase. This repository is a fork of the the original Breedbase Dockerfile. T3 will periodically update this image and it is available for download on Docker Hub as triticeaetoolbox/breedbase_web.

If you are looking run a prebuilt T3/Breedbase image, follow the instructions in the TriticeaeToolbox/breedbase repository. This repo includes instructions on how to set up your Docker host along with helper scripts to setup the intial Breedbase instance(s) and update them when a new image is released.

The main differences between this T3 version of Breedbase and the original Breedbase image include:

• the use of the T3 sgn repo (main codebase for breedbase)
  • the T3 version includes some T3-specific changes and features
• pre-loaded trait ontologies for wheat, oat, and barley
• can be used in conjunction with the TriticeaeToolbox/breedbase repository for the Docker host setup and helper scripts

Build Instructions

Update Repositories

Before building the new Docker image, make sure the t3/master branch of the TriticeaeToolbox/sgn repo and all of the instance branches (triticum, triticum-sandbox, avena, etc) of the TriticeaeToolbox/mason repo are updated with the latest changes that are to be included in the new Docker image build.

For example, to update the t3/master branch of the TriticeaeToolbox/sgn repo with changes from the upstream solgenomics/sgn repo using a specific tag:

djw64:sgn ● t3/master:✓ $ git remote -v
origin  git@github.com:TriticeaeToolbox/sgn.git (fetch)
origin  git@github.com:TriticeaeToolbox/sgn.git (push)
sgn     git@github.com:solgenomics/sgn.git (fetch)
sgn     git@github.com:solgenomics/sgn.git (push)
djw64:sgn ● t3/master:✓ $ git fetch origin
djw64:sgn ● t3/master:✓ $ git checkout t3/master
djw64:sgn ● t3/master:✓ $ git pull
djw64:sgn ● t3/master:✓ $ git fetch sgn
djw64:sgn ● t3/master:✓ $ git merge sgn-309.0
# Fix file conflicts and commit the changes here, if necessary
# Test the code for any major issues
djw64:sgn ● t3/master:✓ $ git push
# !! Remember to push the tags as well, if you want the latest 
# tag to be displayed in the footer of the website
djw64:sgn ● t3/master:✓ $ git push --tags

Build Docker Image

To build a new docker image, use the ./scripts/build.sh script:

./scripts/build.sh

This script will:

• rebuild the Docker image using the latest version of all of the GitHub repositories
• tag the newly built image with the latest and YYYYMMDD tags

By default, this script will use the t3/master branch of the TriticeaeToolbox/sgn SGN repository.

To change the SGN repository or branch that the image will use, set the SGN_REPO and SGN_BRANCH environment variables before running the build script:

SGN_REPO=solgenomics/sgn SGN_BRANCH=master ./scripts/build.sh

You can also specify the Docker image tags using the following environment variables:

• DOCKER_TAG: defaults to YYYYMMDD as the image tag
• DOCKER_CHANNEL: defaults to latest release channel

If you want to deploy the image right after building it, you can add the --deploy flag to the build script.

Deploy Docker Image

To deploy the image to Docker Hub, first make sure you are logged in using your Docker account (docker login).

Then, run the deploy script to push specified tags of the image (triticeaetoolbox/breedbase_web by default) to Docker Hub.

./scripts/deploy.sh YYYYMMDD latest

Update Instances

Once the images have been deployed to Docker Hub, use the breedbase script to pull the new images and run the update scripts (run database patches, update trait ontologies, etc) on each server (TCAP, TCAPG, and TCAPS).

breedbase update