waisn-tech-tools

Tech tools for the WAISN.

Setting up Environment

Anaconda is used to manage the python environment that the project runs in. After installing, you can set up the anaconda environment:

# create the conda env
conda env create -f ./environment.yml
# 'waisn-tech-tools' conda env should be listed
conda env list
# activate the environment
source activate waisn-tech-tools
# do a bunch of work
# ...
# ...
# deactivate the env
source deactivate

Updating the Environment

If you are installing new packages, you will want to update the environment file as well.

# install new package
conda install new-package-name
# update environment file
conda env export > ./environment.yml
# please remove the "prefix" key from the file

Project Commands

To see commands specific to the project, e.g. seeding, run:

python manage.py

Running the Server Locally

There are a few environment settings that need to be enabled to run the server. The reason for this is because the website is protected using Auth0. Hence the following environment variables need to be declared. Note that the Auth0 application should be configured to be a Regular Web Application.

• AUTH0_DOMAIN: The Auth0 application's domain
• AUTH0_KEY: The Auth0 application's client id
• AUTH0_SECRET: The Auth0 application's client secret.

Disabling Auth0

Runnning the service locally without access to the internet requires authentication to be disabled. This can be done by setting the environment variable:

# disable Auth0 login requirement
export WAISN_AUTH_DISABLED='TRUE'

Running the Server in Production

There are two settings configurations:

• Development: waisntechtools/waisntechtools/settings/development.py
• Production: waisntechtools/waisntechtools/settings/production.py

The production settings file should be used, naturally, in production. Settings files can be specified via the Django runserver command i.e.:

python ./manage.py runserver --settings waisntechtools.settings.production

There are additional environment settings that need to be set:

• DJANGO_SECRET_KEY: See Django SECRET_KEY Docs
• DB_HOSTNAME: database hostname
• DB_PORT: port the database server is listening on
• DB_NAME: name of database to use
• DB_USERNAME: username used to access the database
• DB_PASSWORD: password used to access the database

Docker

Development Image

You can build the web application using the provided Docker file. This Dockerfile uses a Docker Multi-Stage Build to build both the development and production Docker images. This is done because in allows inheriting the common Dockerfile segments.

# build the development Docker image: must be in the same directory as the Dockerfile file
docker build . --target waisntechtools-dev
# run the docker file
docker run -p 8000:8000 --rm [environment variables] ${IMAGE_ID}

Production Image

Build the production image using a similar command for the development, but changing the target:

# build the prod Docker image
docker build . --target waisntechtools-prod

If you want to test the production docker image, you will need to have a MySQL server running. One possible approach is you can spin up a MariaDB Docker container.

# spin up the MariaDB container port forwarding 5000 on the local host to 3306 in the Docker container
docker run -p 5000:3306 --rm --name waisn-mariadb -e MYSQL_ROOT_PASSWORD=pw -d mariadb:latest
# verify that we can connect to it using the MySQL client (you will be prompted to put in the password)
mysql -h localhost -P 5000 -u root -p
# create the database used by the service
MariaDB [(none)]> create database waisntechtools;

Before using the production image, let's first try to get the service running locally and using the MariaDB container as the DB:

# run the needed migrations
export DJANGO_SECRET_KEY=KEY; \
  export DB_HOSTNAME=127.0.0.1; \
  export DB_PORT=5000; \
  export DB_NAME=waisntechtools; \
  export DB_USERNAME=root; \
  export DB_PASSWORD=pw; \
  python manage.py migrate --settings waisntechtools.settings.production
# run the server
export DJANGO_SECRET_KEY=KEY; \
  export DB_HOSTNAME=127.0.0.1; \
  export DB_PORT=5000; \
  export DB_NAME=waisntechtools; \
  export DB_USERNAME=root; \
  export DB_PASSWORD=pw; \
  python manage.py runserver --settings waisntechtools.settings.production

Sweetness. Let's now run the server in a Docker container. Because this will run the server in the default Docker bridge, we cannot use DNS resolution using the Docker container name. Hence, we'll need to figure out the IP address of the container in the default network:

docker inspect -f '{{.NetworkSettings.Networks.bridge.IPAddress}}' waisn-mariadb

We can then use this IP address to connect the WAISN Docker container to the MariaDB:

# while we've already run migrations, if you have authentication enabled, you'll need to run it again because with
# authentication, the Auth0 tables need to be created.
# Notice that we use the port in the Docker network instead of the one exposed on the host.
docker run -p 8000:8000 --rm -d \
    -e DJANGO_SECRET_KEY=KEY \
    -e DB_PORT=3306 \
    -e DB_NAME=waisntechtools \
    -e DB_USERNAME=root \
    -e DB_PASSWORD=pw \
    -e DB_HOSTNAME=${DB_CONTAINER_IP_ADDR} \
    ${IMAGE_ID}