How to deploy a custom branch of Toucan Connectors on a live instance¶

This page describes a process for deploying a custom branch of the Toucan Connectors.

Requirements¶

This page requires you to have:

A live instance of at least laputa (and tucana if you wish).
An access to Shaun

Steps in toucan-connectors¶

Create a new branch with an appropriate name. For instance: f/my_feature
Make sure that the remote branch is up to date with your latest modifications.

Steps in laputa¶

Create a new branch.
Modify the dependency installation step in the Dockerfile :
Look for this step:

RUN if [ "$test_build" != "true" ] ; then \
    # building first because poetry install --only main will remove build dependencies
    poetry build --format wheel &&\
    poetry install --no-root  --all-extras --only main; fi

Change it to (if the latest connector version is 0.47.0):

RUN if [ "$test_build" != "true" ] ; then \

    poetry add toucan-connectors@0.47.0 &&\

    # building first because poetry install --only main will remove build dependencies
    poetry build --format wheel &&\
    poetry install --no-root --only main --all-extras; fi

The poetry install --no-root --all-extras --only main will install your custom branch of the toucan-connectors (just the connectors code, not the dependencies).

Steps in Shaun¶

Find your back instance.
Edit the toucan image version field with the name of your laputa branch and save.
Build and redeploy the whole stack for the concerned instance

Once you are finished¶

Do not forget to clean the laputa branch and delete it if necessary !