Skip to content

Latest commit

 

History

History
110 lines (67 loc) · 3.76 KB

README.md

File metadata and controls

110 lines (67 loc) · 3.76 KB
Raw

docker-mytardis

Deployment - Docker compose

Development

Dev. MyTardis develop branch

$ git clone -b develop --recursive https://github.com/UWA-FoS/docker-mytardis.git mytardis
$ cd mytardis

Required to contribute the the MyTardis project.

This will pull all the MyTardis develop branch source and set docker-compose.yml file for the latest UWA develop docker image with prerequisites for testing, etc...

To contribute to the MyTardis project please read the CONTRIBUTING.rst.

Dev. UWA production build.

$ git clone --recursive https://github.com/UWA-FoS/docker-mytardis.git mytardis
$ cd mytardis

Required to add new features and/or settings to the current UWA production MyTardis service.

General dev. instructions

  • rename the relevant env_template.MODULE file removing the "_template" from the name.
  • edit the env.MODULE files with the required settings.
  • template file that are not required, ensure the files are renamed and blank OR remove the relevant entry in the docker-compose.yml file.
  • edit Dockerfile and/or docker-compose.yml to your desired settings / alterations.
$ docker-compose pull                  # acquire the latest image from DockerHub
$ docker-compose up -d                 # start docker containers
$ docker-compose logs --no-color -f    # check logging output

(wait for logging output to stop, usually after a group of lines like this, then interrupt with Ctrl-C:)

        django_1    | [2018-02-26 04:37:36 +0000] [106] [INFO] Booting worker with pid: 106
        django_1    | [2018-02-26 04:37:36 +0000] [111] [INFO] Booting worker with pid: 111
        django_1    | [2018-02-26 04:37:36 +0000] [114] [INFO] Booting worker with pid: 114

$ docker-compose exec django python mytardis.py createsuperuser

Once the startup process has completed point you browser to http://localhost:8001/ and login using the credentials provided to the createsuperuser script above.

This development uses Git Submodules to incorporate other code bases into the build process were appropriate, such as the MyTardis source. To work on a different upstream version you should follow "Working on a Project with Submodules", "Pulling in Upstream Changes". E.g.,

To pull the latest upstream changes from MyTardis.
From the cloned project directory run
$ cd src/mytardis
$ git fetch
$ git merge origin/master
$ cd ../..
$ docker-compose build

Configuration

Configuration can be accomplished in a number of different was as circumstance dictates.

Docker build settings

  • Dockerfile

  • docker-entrypoint.d/

    Processed in the Django containers.

    Dump directory for Docker entrypoint bash scripts.

    The scripts are executed in the startup shell (not spawned) and are processed in lexical order.

  • docker-entrypoint_celery.d/

    Processed in the Celery containers.

    Dump directory for Docker entrypoint bash scripts.

    The scripts are executed in the startup shell (not spawned) and are processed in lexical order.

  • settings.d/

    Django settings dump directory.

Docker compose image instantiation settings

  • docker-compose.yml

    • env.MODULE

      Entries to these are placed in the docker-compose.yml file env_file and allow environment settings for container instances/deployments.

      env_template.MODULE templates are provided for examples and reference. Alter the settings for your deployment and rename the files to env.MODULE (remove the _template part of the name).

References

Ref. Source

MyTardis

Ref. Docker

Django docker container