Skip to content

Commit b9c3a45

Browse files
committed
doc: remove numbers from headers
1 parent bb04c67 commit b9c3a45

8 files changed

Lines changed: 41 additions & 41 deletions

docs/constraints.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Anything that constrains teams in design and implementation decisio
1111

1212
The architectural constraints outlined in this section shape the design decisions for the 1+MG Network. They are non-negotiable limitations imposed by regulation, politics, or organization.
1313

14-
## 1. Regulatory & Legal Constraints
14+
## Regulatory & Legal Constraints
1515

1616
| ID | Constraint | Description |
1717
| :------ | :--------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -23,14 +23,14 @@ The architectural constraints outlined in this section shape the design decision
2323
| **L06** | **NIS2 Directive (Cybersecurity)** | As a "Critical Entity" (Health Sector), the infrastructure must implement state-of-the-art cyber hygiene, mandatory incident reporting (24h warning/72h full report), and supply chain security auditing.[^5] |
2424
| **L07** | **International Transfers (GDPR Ch. V)** | Connections to **Global Resources** (e.g., All of Us, H3Africa) situated in non-EEA countries without an adequacy decision must rely on **Standard Contractual Clauses (SCCs)** or specific derogations (Art. 49).[^27] |
2525

26-
## 2. Political Constraints
26+
## Political Constraints
2727

2828
| ID | Constraint | Description |
2929
| :------ | :------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3030
| **P01** | **Local Sovereignty (The "Red Line")** | The architecture must ensure that **Local Data Authorities (DACs)** retain absolute vetting power over every access request. No "Central Super-Admin" can exist who can view data without local approval.[^6] |
3131
| **P02** | **Equity & Inclusivity** | The system must support smaller Member States with limited infrastructure. It cannot mandate expensive hardware (e.g., proprietary HPC) that would exclude less-resourced nations (The "Widening" principle).[^7] |
3232

33-
## 3. Organizational Constraints
33+
## Organizational Constraints
3434

3535
| ID | Constraint | Description |
3636
| :------ | :------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -50,7 +50,7 @@ The architectural constraints outlined in this section shape the design decision
5050
| **O14** | **Project Funding Cycles** | Sustainability must be planned beyond typical 3-5 year EU project funding cycles. |
5151
| **O15** | **Reprocessing Cost Sensitivity** | The architecture must account for significant cost disparities in data reprocessing (e.g., ~€5 for short-read vs ~€530 for long-read per genome), necessitating careful decisions on when and where to standardize data [^10]. |
5252

53-
## 4. Technical Constraints
53+
## Technical Constraints
5454

5555
| ID | Constraint | Description |
5656
| :------ | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

docs/crosscutting-concepts.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ description: Overall, principal regulations and solution approaches relevant in
99

1010
# Cross-cutting Concepts
1111

12-
## 1. Data Strategy
12+
## Data Strategy
1313

14-
### 1.1. Metadata Model (HealthDCAT-AP)
14+
### Metadata Model (HealthDCAT-AP)
1515

1616
To ensure semantic interoperability and alignment with the **European Health Data Space (EHDS)**, 1+MG adopts the **HealthDCAT-AP 5.0** standard (a health-specific profile of DCAT-AP)[^1] [^2] [^3].
1717

@@ -24,7 +24,7 @@ To ensure semantic interoperability and alignment with the **European Health Dat
2424
- **Distribution:** The physical form (`dcat:Distribution`).
2525
- _Example:_ VCF File, Beacon API Endpoint, WES Endpoint.
2626

27-
### 1.2. Identifier Schema
27+
### Identifier Schema
2828

2929
All resources within the 1+MG network MUST adhere to the following **Persistent Identifier (PID)** pattern to guarantee global uniqueness across the federation[^1]:
3030

@@ -42,11 +42,11 @@ All resources within the 1+MG network MUST adhere to the following **Persistent
4242
- `GDI-FI-COHORT-001` (First cohort from Finland GDI Node)
4343
- `GOE-ES-SAMPLE-9942` (Genome of Europe sample from Spain)
4444

45-
## 2. Security & Compliance
45+
## Security & Compliance
4646

47-
## 2. Security & Compliance
47+
## Security & Compliance
4848

49-
### 2.1. Data Protection by Design (Five Safes)
49+
### Data Protection by Design (Five Safes)
5050

5151
We adhere to the **Five Safes** framework to demonstrate compliance with GDPR Data Protection by Design and Default (DPbDD)[^11]:
5252

@@ -56,33 +56,33 @@ We adhere to the **Five Safes** framework to demonstrate compliance with GDPR Da
5656
4. **Safe Settings:** Does the access facility limit unauthorized use? (Secure Processing Environment).
5757
5. **Safe Outputs:** Is confidentiality maintained for outputs? (Airlock/Egress Control).
5858

59-
### 2.2. Controlled Vocabularies
59+
### Controlled Vocabularies
6060

6161
We rely on the **Data Privacy Vocabulary (DPV)** to express legal bases and consent status in a machine-readable way[^5].
6262

6363
- `dpv:Consent`: Processing based on explicit data subject consent.
6464
- `dpv:LegitimateInterest`: Processing based on legitimate interest (secondary use).
6565

66-
### 2.3. Encryption
66+
### Encryption
6767

6868
- **Data at Rest:** All genomic files (VCF/BAM) are encrypted using **Crypt4GH** (standard container format for encrypted genomic data)[^6].
6969
- **Data in Transit:** TLS 1.3 is mandatory for all APIs.
7070

71-
### 2.4. Authentication & Authorization
71+
### Authentication & Authorization
7272

7373
- **Authentication:** Federated via **LS AAI**. Users authenticate at their Home Organisation (IdP).
7474
- **Authorization:** Claims are transported via **GA4GH Passports**[^7].
7575
- **Visas:** Signed JWTs asserting permissions (e.g., `ControlledAccessGrants`).
7676
- **Verification:** The National Node PEP MUST cryptographically verify the Visa signature against the DAC's public key[^8].
7777

78-
## 3. Observability & Reliability
78+
## Observability & Reliability
7979

80-
### 3.1. Logging & Auditing
80+
### Logging & Auditing
8181

8282
- **Audit Trails:** Every access to genomic data (successful or denied) MUST be logged.
8383
- **Privacy:** Logs must NOT contain PII (e.g., query parameters with variant details) but MUST record User ID, Resource ID, Timestamp, and Decision[^5].
8484

85-
### 3.2. Error Handling
85+
### Error Handling
8686

8787
- **Standard:** APIs must return standard HTTP status codes (401 vs 403 distinction is critical).
8888
- **Format:** Error bodies MUST follow **RFC 7807** (Problem Details for HTTP APIs)[^10].

docs/oneplusmg-infrastructure/building-block-view.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Static decomposition of the system, abstractions of source-code, sh
99

1010
# Building Block View
1111

12-
## 1. Whitebox Overall System (Level 1)
12+
## Whitebox Overall System (Level 1)
1313

1414
The 1+MG Infrastructure is decomposed into three primary logical zones:
1515

@@ -19,7 +19,7 @@ The 1+MG Infrastructure is decomposed into three primary logical zones:
1919
| **Trust & Identity Broker (Central)** | **Functional Description:** Aggregates Claims from DACs and identities from LS AAI into GA4GH Passports.<br/>**Interfaces:** OIDC, GA4GH Passport API.<br/>**Quality:** High Availability, High Security (Signatures).<br/>**Location:** `src/broker`. |
2020
| **National Node (Federated)** | **Functional Description:** Stores encrypted genomic data and executes local compute workflows.<br/>**Interfaces:** WES (Compute), DRS (Data), Beacon (Discovery).<br/>**Quality:** High Security (Encryption), Data Sovereignty.<br/>**Location:** `src/node`, Hosted by Member State. |
2121

22-
## 2. Level 2: 1+MG User Portal
22+
## Level 2: 1+MG User Portal
2323

2424
The User Portal is the central entry point for researchers, integrating several distinct services[^4].
2525

@@ -29,17 +29,17 @@ The User Portal is the central entry point for researchers, integrating several
2929
| **Dataset Catalogue** | **Functional Description:** Searchable registry of available datasets (CKAN/FAIR).<br/>**Interfaces:** HTTPS.<br/>**Location:** `https://catalogue.portal.gdi.lu` |
3030
| **DAAMS** | **Functional Description:** Manages the **Single Access Principle** workflow. Routes requests to Central DAC for review and then to National Nodes for Veto/Validation.<br/>**Interfaces:** HTTPS.<br/>**Location:** `https://daam.portal.gdi.lu` |
3131

32-
## 3. Level 2: National Node (GDI Node)
32+
## Level 2: National Node (GDI Node)
3333

3434
The National Node is the most complex component. It must be deployed by each Member State.
3535

36-
### 3.1. Discovery Layer (Beacon)
36+
### Discovery Layer (Beacon)
3737

3838
- **Beacon v2 API:** Receives queries (e.g., "Do you have variant X?").
3939
- **Metadata DB:** Stores the HealthDCAT-AP catalogue (Cohorts, Datasets).
4040
- **Response Strategy:** Checks local policies before returning `TRUE`/`FALSE` or counts[^2].
4141

42-
### 3.2. Secure Processing Environment (SPE) / TRE
42+
### Secure Processing Environment (SPE) / TRE
4343

4444
This component follows the **TRE-FX** reference architecture for secure computation[^3].
4545

@@ -50,20 +50,20 @@ This component follows the **TRE-FX** reference architecture for secure computat
5050
- **Isolation:** The Compute Nodes have **NO direct internet access**. All dependencies (containers, reference genomes) must be available locally or proxied via the Airlock[^4].
5151
- **Data Staging:** Pulls encrypted data from the Archive for the duration of the job.
5252

53-
### 3.3. Data Archive
53+
### Data Archive
5454

5555
- **Encryption Layer:** Manages keys for data-at-rest encryption (Crypt4GH)[^5].
5656
- **Data Integrity Service:** Ensures file validity using checksums and periodic scrubbing[^4].
5757
- **Object Storage:** S3-compatible storage for VCF, BAM, and CRAM files.
5858
- **Data Repository Service (DRS):** Resolves logical IDs (`drs://gdi...`) to physical signed URLs for internal compute use.
5959

60-
### 3.4. Data Onboarding & Curation
60+
### Data Onboarding & Curation
6161

6262
- **Ingest Pipeline:** Validates quality of incoming data from Data Providers (integrity, format).
6363
- **Pseudonymisation Service:** Replaces direct identifiers with 1+MG specific pseudonyms before long-term storage (Separation of Concerns).
6464
- **Metadata Mapper:** Transforms local metadata into the common GDI model (HealthDCAT-AP).
6565

66-
### 3.5. Local Access Control
66+
### Local Access Control
6767

6868
- **Policy Enforcement Point (PEP):** Intercepts every API call. Validates the User's GA4GH Passport and the specific Visas against the dataset's Access Control List (ACL).
6969

docs/oneplusmg-infrastructure/deployment-view.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ description: Technical infrastructure with environments, computers, processors,
1111

1212
The deployment architecture respects the **Data Residency** constraints (Constraint L02) by physically separating the Central Services from the National Storage.
1313

14-
## 1. Infrastructure Overview
14+
## Infrastructure Overview
1515

1616
| Infrastructure Element | Environment | Geography | Responsibility |
1717
| :-------------------------------- | :----------------------------- | :---------------------------------------------- | :------------------------------------------------ |
1818
| **Central Hub (Portal/Registry)** | Cloud | Luxembourg (EU Region) | Managed by **Genome EDIC**. |
1919
| **National Node Infrastructure** | Regional Cloud / HPC / On-Prem | Country-Specific (e.g., CSC Finland, BSC Spain) | Managed by **Member State**. |
2020
| **Network Layer** | Public Internet (TLS 1.3) | Global | Secure encrypted channels over standard internet. |
2121

22-
## 2. Zoned Network Architecture
22+
## Zoned Network Architecture
2323

2424
To satisfy **Data Protection by Design (DPbDD)**, the National Node network is segmented:
2525

@@ -29,7 +29,7 @@ To satisfy **Data Protection by Design (DPbDD)**, the National Node network is s
2929
| **Secure / Internal** | **No internet access** (Airgapped). | Internal Mesh Only. | Compute Cluster, WfExS, Data Archive |
3030
| **Management** | Admin access only. | SSH/VPN. | Monitoring, Logging, Key Management |
3131

32-
## 3. Deployment Diagram
32+
## Deployment Diagram
3333

3434
```mermaid
3535
graph TD
@@ -60,7 +60,7 @@ graph TD
6060
ReverseProxy -->|Proxy Job| WfExS
6161
```
6262

63-
## 3. Node Requirements (The "Starter Kit")
63+
## Node Requirements (The "Starter Kit")
6464

6565
Each Member State is expected to provision the following baseline resources to run the GDI Starter Kit:
6666

@@ -69,7 +69,7 @@ Each Member State is expected to provision the following baseline resources to r
6969
- **Compute:** High-Memory Nodes for Workflow Execution (e.g., 64GB+ RAM for alignment jobs).
7070
- **Security:** HSM or Key Management Service (KMS) for Crypt4GH keys.
7171

72-
## 5. Environment Strategy
72+
## Environment Strategy
7373

7474
To ensure stability and "Five Safes" compliance, we define three environments:
7575

docs/oneplusmg-infrastructure/runtime-view.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Behavior of building blocks as scenarios, covering important use ca
99

1010
# Runtime View
1111

12-
## 1. Data Access Workflow (The "Single Access Principle")
12+
## Data Access Workflow (The "Single Access Principle")
1313

1414
This scenario describes the primary flow for a researcher to discover, request, and access genomic data across borders, illustrating the interplay between central governance and local sovereignty[^1] [^2].
1515

@@ -58,7 +58,7 @@ sequenceDiagram
5858
5. **Provisioning:** If approved by all (or a subset of) nodes, the corresponding permissions are minted as **GA4GH Visas** by the **Trust Broker**.
5959
6. **Secure Processing:** The researcher receives a **GA4GH Passport** containing these Visas. They submit a compute request (WES) to the National Node. The Node's **Policy Enforcement Point (PEP)** validates the Passport against the local access control list before executing the workflow in the isolated **SPE**.
6060

61-
## 2. Secure Processing Workflow (TRE-FX)
61+
## Secure Processing Workflow (TRE-FX)
6262

6363
This scenario details the execution phase (`ujGdi08`), focusing on how the **Secure Processing Environment (SPE)** ensures isolation while allowing external analysis[^2] [^3].
6464

docs/oneplusmg-infrastructure/solution-strategy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ description: Summary of the fundamental decisions and solution strategies that s
99

1010
# Solution Strategy
1111

12-
## 1. Governance & Federation
12+
## Governance & Federation
1313

1414
The fundamental strategic decision for 1+MG is **Federation**.
1515

1616
- **No Central Data Lake:** Genomic data is too sensitive and voluminous to move. It remains legally and physically within the Member State (National Node)[^1].
1717
- **Bring Compute to Data:** Analysis algorithms are containerized (e.g., Nextflow pipelines) and dispatched to the data location, returning only aggregated results.
1818
- **Sovereignty First:** The architecture prioritizes the **Local Data Authority (DAC)**. No access is granted without a cryptographically verifiable token from the local DAC.
1919

20-
## 2. Trust Framework
20+
## Trust Framework
2121

2222
We employ a **Zero Trust** approach where identity and authorization are decoupled[^2].
2323

2424
- **Identity (Who are you?):** Verified by **LS AAI** (Life Science Authentication and Authorization Infrastructure). Users log in via their home university or research institute.
2525
- **authorization (What can you do?):** Managed by **GA4GH Passports**. DACs issue "Visas" (signed claims) that travel with the user's request. The National Node verifies these Visas before executing any query or workload.
2626

27-
## 3. Technology Stack & Standards
27+
## Technology Stack & Standards
2828

2929
To ensure interoperability across 27+ countries, we rely strictly on open standards[^3].
3030

@@ -37,7 +37,7 @@ To ensure interoperability across 27+ countries, we rely strictly on open standa
3737
| **Containerization** | **Docker** / **Singularity** | Ensuring reproducible analysis environments. |
3838
| **Orchestration** | **Kubernetes** | Managing the lifecycle of microservices and compute jobs. |
3939

40-
## 4. Organizational Strategy
40+
## Organizational Strategy
4141

4242
- **GDI Starter Kit:** To support smaller Member States, we provide a "Reference Implementation" (Starter Kit) that can be deployed out-of-the-box to spin up a compliant National Node[^4]. It includes **Galaxy Europe** integration, **Beacon v2**, and **WfExS**.
4343
- **Separation of Concerns:** The **Genome EDIC** handles the catalog and governance logic, while **Member States** handle the storage and compute infrastructure.

docs/quality-requirements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Quality requirements as scenarios, with quality tree to provide hig
99

1010
# Quality Requirements
1111

12-
## 1. Quality Tree
12+
## Quality Tree
1313

1414
The following quality attributes are critical for the success of the 1+MG Node.
1515

@@ -20,7 +20,7 @@ The following quality attributes are critical for the success of the 1+MG Node.
2020
| **Usability** | **High** | The application process must be transparent for researchers. |
2121
| **Performance** | **Medium** | Discovery queries should be interactive; Compute jobs can be batch/long-running. |
2222

23-
## 2. Quality Scenarios
23+
## Quality Scenarios
2424

2525
These scenarios map to the Sequence Diagrams in the **Runtime View**.
2626

0 commit comments

Comments
 (0)