Cartblanche22 Build Instructions

Development environment inside cluster

• Clone repo

 Git clone https://gitlab.docking.org/chinzo/molecule-shopping-cart
 Cd molecule-shopping-cart

• Create conda environment with python 3.7, install dependencies

 conda env create -f environment.yml
 conda activate cartblanche

• Start application

 ./boot-test.sh

Deployment Information

Gitlab Deployment Stages

Production builds are distributed among 3 machines

   - epyc2
   - n-9-38
   - n-1-18

The first stage will build/update the current docker image to the gitlab server running on n-9-22. On the web interface, this is in the cartblanche repo under 'Packages & Registries'.

Finally, the docker image is pulled in each of the three servers and restarted.

Useful Commands (Use these in the respective server to debug):

 sudo docker restart cartblanche22 (restart the docker container)
 sudo docker logs cartblanche22 (view app logs)

Some troubleshooting tips: Cartblanche relies on other outside services (smallworld, arthur, databases) so it’s good to check the status of those before looking into the code.

For smallworld, check the status of api calls, or run a sample query.

For arthor, check the status of api class, or run a sample query.

For search errors (zincid, smiles, vendor), the docker app logs are usually very informative.

It is also useful to see the status of the redis and redis-sentinel services on each of those machines.

There are three redis databases, one main and two backups. If the main db goes down, one of the backups becomes main. When the old main goes back up, it becomes a backup database.

Deployment Process

Deployment is as simple as pushing changes to the respective branch. A docker image will be created with the new version of the code, which will then replace the current version. To redeploy manually, go to https://gitlab.docking.org/chinzo/molecule-shopping-cart/-/pipelines/new

Setting up Auto-Deployment

• Follow the instructions on setting up a new gitlab runner, found here.

• Register the runner with the credentials provided in the link above.

• Set ‘shell’ as the executor for the runner when prompted.

• After configuration, the gitlab-runner config found in /etc/gitlab-runner/config.toml should look something like this:

 oncurrent = 1
 check_interval = 0
 [session_server]
   session_timeout = 1800
 runners
   name = "cartblanche n-1-17"
   url = "http://gitlab.docking.org/"
   token = "Lvp2X3zRFAN_JQuVZK3y"
   privileged = true
   executor = "shell"
   builds_dir = "/home/cartblanche"
   [runners.custom_build_dir]
   [runners.docker]
     privileged = true
     disable_cache = false
     cache_dir = "cache"
    [runners.cache]
    [runners.cache.s3]
    [runners.cache.gcs]
    [runners.cache.azure]

Return to https://gitlab.docking.org/admin/runners, where the new runner will be displayed. Edit the runner’s tags to describe what the runner will be deploying. For example, the test server has the tag ‘cartblanche-dev’ and the production server has ‘cartblanche22’. Once the tag is set, a new job will need to be added to the gitlab deployment script to deploy the correct branch to the correct machine. https://gitlab.docking.org/chinzo/molecule-shopping-cart/-/blob/master/.gitlab-ci.yml

A sample job will look like so:

 services:
   - redis:latest
 deploy-dev job:
     only:
         - dev
     stage: deploy
     services:
         - redis:latest
     tags:
         - cartblanche-dev
     script:
         - docker login ${GITLAB_REGISTRY_URL} -u ${GITLAB_REGISTRY_USER} -p ${GITLAB_REGISTRY_PASS}
         - docker pull ${GITLAB_REGISTRY_URL}/mar/cartblanche22
         - docker stop ${CI_PROJECT_NAME}
         - docker run --net cartblanche --name redis -d redis
         - docker run --net cartblanche -v /nfs/db2/smallworld_anon_21Q4:/nfs/db3/private_smallworld_4th_gen/anon
                    -v /export/db4/smallworld-java:/export/db4/smallworld-java
                    -v /nfs/db3/private_smallworld_4th_gen/smallworld.cfg:/nfs/db3/private_smallworld_4th_gen/smallworld.cfg
                    -v /nfs/db3/private_smallworld_4th_gen/maps:/nfs/db3/private_smallworld_4th_gen/maps
                    --name ${CI_PROJECT_NAME} -d -p 0.0.0.0:5068:5000 ${CI_PROJECT_NAME}:${CI_COMMIT_REF_NAME}-0.1.${CI_JOB_ID}

• The name ‘deploy-dev’ refers to the job name.

• 'only: -dev' refers to the script only deploying the dev branch. More branches can be added to deploy pushes to different branches to the same machine.

• 'tags: -cartblanche-dev' refers to the job tags, which determines which machine will take care of that deployment job. This can be changed to the tag that was set up earlier. You can also add multiple tags to deploy the same branch (or branches) to multiple machines at the same time.

• 0.0.0.0:5068 refers to the port that points to the application.