Kurz gesagt
Ferrum ist ein GA4GH-Gateway in Rust. Es läuft als Edge-Bauart auf einem Rechner oder als vollständige Bauart mit Datenbank, Objektspeicher und Anmeldedienst. Frühe Nutzung, Apache 2.0.
Aufbau
Links die Einrichtung mit Speicher, Anmeldung und Freigabedienst. In der Mitte Ferrum mit den Schnittstellen. Rechts der Partner. Die Pfeile 1 bis 5 sind Betrieb, Finden, Anfrage, Entscheidung und Auslieferung.
Ihre Einrichtung
- Speicher mit Ihren Dateien
- Anmeldung
- Freigabedienst, entscheidet
Ferrum
- Standardschnittstellen
- prüft die Freigabe
- liefert die Datei aus
- Protokoll
Partner
- findet
- fragt an
- lädt herunter
- 1 Institut betreibt
- 2 Partner findet
- 3 Anfrage
- 4 Institut entscheidet
- 5 Datei ausliefern
ferrum-gateway
Speicher, Anmeldung, Freigabe
Protokoll und Zeit
Schnittstellen und Standards
Im Quellcode der vollen Bauart sind sieben Schnittstellen vorhanden. Vorhandener Code ist kein Ende-zu-Ende-Test.
| Schnittstelle | Was es heißt | Bauart | Stand |
|---|---|---|---|
| DRS | ein Standard, um Dateien zu finden und zu holen | beide | im Quellcode |
| WES | ein Standard, um Analyseabläufe auszuführen | nur volle Bauart | im Quellcode |
| TES | ein Standard, um Analyseabläufe auszuführen | nur volle Bauart | im Quellcode |
| TRS | ein Standard, um Analysewerkzeuge zu registrieren | nur volle Bauart | im Quellcode |
| htsget | ein Standard, um Sequenzierdateien zu holen. In Ferrum heute ganze Dateien | beide | heute ganze Dateien |
| Beacon | fragt, ob eine Variante vorkommt, ohne die Daten zu zeigen | beide | ein Teil der Pfade |
| Crypt4GH | ein Verschlüsselungsformat für Genomdateien | beide | im Quellcode |
| Passports | ein Standard, um zu belegen, wer worauf zugreifen darf. Die volle Bauart bringt sie aus diesem Programm mit. Bei externer Anmeldung nennt das Protokoll ga4gh-infra | volle Bauart, aus diesem Programm | nicht in Edge |
Bausteine im Betrieb
| Baustein | Wofür | Stand |
|---|---|---|
| Postgres | die Datenbank der vollen Bauart | volle Bauart |
| SeaweedFS | der Objektspeicher der vollen Bauart | volle Bauart |
| Keycloak | das Anmeldesystem der vollen Bauart | volle Bauart |
| Docker | ein Weg, ein Programm mit seinen Abhängigkeiten zu starten | ohne Docker |
| Kubernetes | eine Umgebung, die viele Rechner wie einen betreibt | Es wurde noch nicht installiert. |
| Helm | ein Paketformat für Kubernetes. Das Chart liegt bei und wurde noch nicht installiert | Es wurde noch nicht installiert. |
Betrieb
Sicherheit
Tests und Nachweise
Lizenz
Reifegrad
Dokumentation auf GitHub
Technische Berichte
Die veröffentlichten Berichte gehören zu Ferrum.
- Berichtsserie
- SF-TR-2026-001, Architektur
- SF-TR-2026-002, Field und Edge
- Whitepaper
- DOI des ersten Berichts
- DOI des zweiten Berichts
Grenzen
- Die verlinkten Unterlagen sagen keine Supportzeiten zu.
- Das Helm-Chart wurde noch nicht installiert.