How infomics/mdr-ra-opal-datashield-documentation works
Project Type and Purpose
This is a deployment configuration project for a federated data analysis system (Opal-DataSHIELD) specifically tailored for the MDR-RA project. The system enables secure, privacy-preserving analysis of distributed data across multiple partners.
Main Components
A. Infrastructure Layer:
• Docker Container Environment
• Traefik Reverse Proxy (for SSL termination and routing)
• SSL/TLS Certificate Management
B. Core Services:
• Opal Server
• R Server (ROCK)
• DataSHIELD Analysis Engine
C. Security Components:
• Two-Factor Authentication (2FA)
• Permission Management System
• SSL/TLS Encryption
D. Data Management:
• Project Storage
• File System
• Table Management
┌─ Client Layer ─────────────────────────┐
• Web Browsers │
• R Clients │
• ┬─────────────────────────┘
• (HTTPS)
┌─ Gateway Layer ────────────────────────┐
• Traefik Reverse Proxy │
• SSL/TLS Termination │
• ┬─────────────────────────┘
┌─ Application Layer ───────────────────┐
• ┌─ Security ─┐ ┌─ Core Services ─┐ │
• 2FA │ │ - Opal Server │ │
• Auth │ │ - ROCK (R) │ │
• ┘ │ - DataSHIELD │ │
• ┘ │
• ┬────────────────────────┘
┌─ Data Layer ──────────────────────────┐
• Project Storage │
• File System │
• Tables │
• ┘
Key Elements to Highlight
• Blue: Core services
• Green: Security components
• Orange: Data management
• Gray: Infrastructure components
• Client → Traefik → Opal Server
• Opal Server ↔ R Server
• Opal Server ↔ Data Storage
c. Security boundaries:
• SSL/TLS encryption points
• Authentication checkpoints
Implementation Notes
• Clear labels and annotations
• Maintain proper spacing and alignment
• Version numbers where relevant
Documentation Integration
• A brief overview of each component
• Configuration requirements
• Security considerations
• Deployment prerequisites
• Scaling capabilities