Containers

The blackbar anonymization, pseudonymization flows, the apps and the API are all available as Docker images. They are available through the registry at https://registry.datatailor.be/v2/.

In order to be able to connect to that registry and download the images, ask for login credentials here, after which you can log in and see the available images and pull the images.

docker login registry.datatailor.be

Images

The following pulls the available images.

## Private images
docker pull registry.datatailor.be/blackbar-apps
docker pull registry.datatailor.be/blackbar-shinyproxy
docker pull registry.datatailor.be/blackbar-api
docker pull registry.datatailor.be/blackbar-modelling
docker pull registry.datatailor.be/blackbar-anonymization
docker pull registry.datatailor.be/blackbar-pseudonymization
docker pull registry.datatailor.be/blackbar-dev-vscode
docker pull registry.datatailor.be/blackbar-dev-rstudio
## Public images
docker pull ghcr.io/bnosac/blackbar-inception-minio-mariadb:0.3.1
docker pull prefecthq/prefect:3.4.22-python3.10

The latest stable release is 1.1 (see release section). So use the according suffix e.g.

docker pull registry.datatailor.be/blackbar-apps:1.1

Environment variables

Connectivity to the database, the model storage, the Inception API and Prefect is done through environment variables.

The following lists up the environment variables needed for the different images. Required to get started are the BLACKBAR_DB_ environment variables which define the connection to the database and the BLACKBAR_S3_ environment variables which define the location where the model is stored.

You can put these environment variables in a .env file such that you can e.g. test running a docker container with

docker run -it --rm --env-file .env registry.datatailor.be/blackbar-anonymization bash

## Environment variables to connect to the database
BLACKBAR_DB=InterSystems IRIS
BLACKBAR_DB_URL=jdbc:IRIS://SERVER:PORT/DOMAIN 
BLACKBAR_DB_USER=XXXXXXXXXX
BLACKBAR_DB_PASSWORD=XXXXXXXXXX
BLACKBAR_DB_TABLES=default
## Environment variables to connect to models on an S3 compatible store (e.g. Minio)
BLACKBAR_S3_ENDPOINT=blackbar.datatailor.be
BLACKBAR_S3_ACCESS_KEY_ID=XXXXXXXXXX
BLACKBAR_S3_SECRET_ACCESS_KEY=XXXXXXXXXX
BLACKBAR_S3_MODEL_BUCKET=blackbar-models
BLACKBAR_S3_MODEL_NAME=deid_v2
## Environment variables to connect to Inception
INCEPTION_HOST=https://inception.datatailor.be/
INCEPTION_USERNAME=XXXXXXXXXX
INCEPTION_PASSWORD=XXXXXXXXXX
## Environment variables to run Prefect scripts
PREFECT_ENVIRONMENT=cloud
PREFECT_API_KEY=XXXXXXXXXX
PREFECT_WORKSPACE=yourcompany/data-flows
PREFECT_WORKPOOL=default-agent-pool
PREFECT_WORKQUEUE=blackbar-test
## Environment variables to connect to Docker/Podman e.g. http://localhost:2375 or unix:///var/run/docker.sock
POD_TYPE=DOCKER
POD_URL=unix:///var/run/docker.sock
## Environment variables for the API
BLACKBAR_API_SECRET=blackbar
BLACKBAR_API_EXPIRATION=365
BLACKBAR_API_ROOT_PATH=/API
## Ollama 
OLLAMA_BASE_URL=https://deid-apps.uzbrussel.be/ollama/
OLLAMA_MODEL=llama3.2

Note on database

BLACKBAR_DB can either be InterSystems IRIS / SQL Server / PostgreSQL / MySQL / MariaDB / Oracle / SQLite
BLACKBAR_DB_URL has the jdbc structure. E.g as follows for SQL Server: jdbc:sqlserver://yourserver:1433;databaseName=yourdb;trustServerCertificate=true

Note on Prefect

PREFECT_ENVIRONMENT can either be ‘cloud’ (if you have Prefect Cloud) or ‘local’ (if you started up Prefect Server locally). If you set it to local, you need to provide the URL of the API. For example.

PREFECT_ENVIRONMENT=local
PREFECT_API_URL=https://blackbar.datatailor.be/prefect-server/api

Note on reverse proxy

If you use the reverse proxy setting as explained here, add the following environment variables.

INCEPTION_HOST=https://blackbar.datatailor.be/inception/
MINIO_BROWSER_REDIRECT_URL=https://blackbar.datatailor.be/s3/

Note on image versions

If you did not pull the latest images or you have built the images yourself, you need to specify the names of the appropriate images. E.g. as follows

## Docker app containers
BLACKBAR_APP_IMAGE_PSEUDONYMIZATION_INSPECTOR=registry.datatailor.be/blackbar-apps:1.1
BLACKBAR_APP_IMAGE_ANONYMIZATION_INSPECTOR=registry.datatailor.be/blackbar-apps:1.1
BLACKBAR_APP_IMAGE_ENTITYDETECTOR_INSPECTOR=registry.datatailor.be/blackbar-apps:1.1
BLACKBAR_APP_IMAGE_COCKPIT=registry.datatailor.be/blackbar-apps:1.1
BLACKBAR_APP_IMAGE_PATIENT_DOCUMENT_CHAT=registry.datatailor.be/blackbar-apps:1.1
BLACKBAR_APP_IMAGE_OLLAMA_CHAT=registry.datatailor.be/blackbar-apps:1.1
BLACKBAR_APP_IMAGE_VSCODE=registry.datatailor.be/blackbar-dev-vscode:1.1
BLACKBAR_APP_IMAGE_RSTUDIO=registry.datatailor.be/blackbar-dev-rstudio:1.1
## Docker job containers
BLACKBAR_IMAGE_MODELBUILDING=registry.datatailor.be/blackbar-modelling:1.1
BLACKBAR_IMAGE_PREFECT_ANONYMIZATION=registry.datatailor.be/blackbar-anonymization:1.1
BLACKBAR_IMAGE_PREFECT_PSEUDONYIMIZATION=registry.datatailor.be/blackbar-pseudonymization:1.1