System Administrator Guide

• Local Test Deployment (several nodes on a single machine)
  • Docker Deployment
  • Keycloak Configuration
  • Testing that the nodes are working
• Loading Data
  • Pre-Requisites
  • v0 (Genomic Data)
    • Example
    • Data Manipulation
  • v1 (I2B2 Demodata)
    • Dummy Generation
    • Example
• Network Architecture
  • External Entities
  • Firewall Ports Opening

This page explains how to deploy and configure MedCo in different scenarios. The first scenario is for development purposes and explains how to deploy 3 nodes on a single server. The second scenario is for test purposes and explains how to deploy 3 nodes on multiple separate servers. Both of those deployments come with some default test data. Note that these two scenarios should not be used in a production environment with real data (e.g, the private keys of the different nodes are public, and the software is still experimental).

Deployment Profiles

When building and running MedCo, a compose-profile and a configuration-profile must be created and used. A compose-profile contains the Docker Compose file that starts a MedCo node. Configurations like ports to expose, log levels, etc. can be set up there. A configuration-profile is a configuration folder shared by the containers and contains things such as keys and certificates. For development purposes, a profile running 3 nodes on a single machine is provided and can be used as is, see Local Test Deployment (several nodes on a single machine). In other scenarios, the profiles must be created.

Specifications

We recommend the following specifications for running MedCo:

• Network Bandwidth: >100 Mbps (ideal), >10 Mbps (minimum), symmetrical
• Ports Opening and IP Restrictions: see Network Architecture

• Hardware

  • CPU: 8 cores (ideal), 4 cores (minimum)
  • RAM: >16 GB (ideal), >8GB (minimum)
  • Storage: dependent on data loaded, >100GB

• Software

  • OS: Any flavor of Linux, physical or virtualized
  • Softwares: Docker & Docker-Compose