Deployment Guide for the Pipelines and the Web App#

Prerequisites#

  • Pipelines artefact

  • Web app artefact

Deployment#

Deploying the pipelines#

  1. Be logged in to the user account corresponding to the required deployment environment (ie DEV, ACC, PROD etc).

  2. Unzip the pipelines artefact.

  3. Open the resultant directory.

  4. Run make deploy . This will perform a series of actions:

    1. deploy-images : Loads the images contained in the artefact, tags them as latest, and pushes them to the local docker registry.

    2. deploy-migrations : This unzips the migrations folder, and then runs the migrations against the database using one of the aforementioned docker images.

    3. deploy-pipelines : This unzips the pipelines folder, containing the Python source code for the pipelines, as well as service files such as the docker-compose.yml file. It then moves the pipelines, starters, service files, and models into the correct locations on the server, and soft links the current directory to the latest version of the pipelines. The systemd service files are then moved to the correct location ( /usr/local/lib/systemd/system/ ). The service timer is then enabled and started.

    4. deploy-scripts : This moves various housekeeping scripts into the correct locations on the server, generally under this corresponding user accounts’ home directories. It then sets the service timers for the scripts and their corresponding services to be enabled and started.

Deploying the web app#

  1. Be logged in to the user account corresponding to the required deployment environment (ie DEV, ACC, PROD etc).

  2. Unzip the web app artefact.

  3. Open the resultant directory.

  4. Run make deploy . This will perform a series of actions:

    1. unpack : This decrypts the PGP encrypted archive, and then unzips the resultant archive.

    2. image : This loads the docker image file into docker.

    3. down : If there is a docker compose file present, this will bring down the docker compose stack.

    4. init : This will delete anything in the target directory, and then create a new empty directory.

    5. install : This will copy the service file ( docker-compose.yml ), as well as additional files such as appsettings.json into the target directory.

    6. up : This will bring up the docker compose stack.