Synaptic Four · Daten & Forschung

Ferrum

Ferrum teilt Forschungsdaten über Standardschnittstellen.

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.

Frühe Nutzung

Aufbau

Wer was übernimmt, Schritt für Schritt.

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. 1 Institut betreibt
  2. 2 Partner findet
  3. 3 Anfrage
  4. 4 Institut entscheidet
  5. 5 Datei ausliefern

ferrum-gateway

Die Edge-Variante und das volle Gateway sind zwei Bauarten desselben Programms in einem Quellcode-Verzeichnis. Welche Schnittstellen enthalten sind, bestimmt die Bauart.

Speicher, Anmeldung, Freigabe

Die volle Bauart arbeitet mit einer Datenbank (Postgres), einem Objektspeicher (SeaweedFS) und einem Anmeldesystem (Keycloak). Die Freigabe für einen Datensatz kommt aus der Anmeldung. Edge nutzt lokale Dateien und hört nur auf dem eigenen Rechner, bis eine andere Adresse gesetzt wird.

Protokoll und Zeit

Ferrum führt ein Protokoll mit Verkettung für erfasste Ereignisse. Die Gesundheitsabfrage prüft die Systemuhr gegen einen Zeitserver, standardmäßig pool.ntp.org. Der Server lässt sich ersetzen.

Schnittstellen und Standards

Im Quellcode der vollen Bauart sind sieben Schnittstellen vorhanden. Vorhandener Code ist kein Ende-zu-Ende-Test.

Schnittstellen und Standards
SchnittstelleWas es heißtBauartStand
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

Bausteine im Betrieb
BausteinWofürStand
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

Ferrum lässt sich auf der eigenen Infrastruktur betreiben. Edge läuft auf einem einzelnen Rechner, auch ohne Docker und ohne Datenbankserver. Die Anleitung nennt für einen Laborlaptop 8 bis 16 GB Arbeitsspeicher und 50 GB freien Speicher.
Ein Helm-Chart für Kubernetes liegt bei. Es wurde noch nicht installiert. Installationsanleitung und Betriebshandbuch liegen im Quellcode. Supportzusagen stehen dort nicht.
In zwei getesteten Aufbauten wurden keine ausgehenden Verbindungen beobachtet. Das ist kein Beleg für jede Konfiguration. Die Zeitabfrage ist vorgesehen.

Sicherheit

Im Programm selbst ist die Anmeldung standardmäßig eingeschaltet. Ist die Konfigurationsdatei ungültig, startet Ferrum nicht.
Ferrum ist in Rust geschrieben. Im eigenen Code kommen vier unsafe-Stellen in drei Dateien vor.

Tests und Nachweise

Die eigenen Prüfungen bestanden am 13. Oktober 2026. Ferrum wird mit HelixTest geprüft. Ein bestandener Lauf ist kein Gütesiegel.
Vier von fünf geprüften Programmen ergaben in zwei sauberen Läufen dieselben Prüfsummen.

Lizenz

Ferrum steht unter der Apache-Lizenz 2.0. Sie dürfen es frei nutzen, verändern und weitergeben, auch gewerblich.

Offener Code und Lizenzen

Lizenzdatei

Reifegrad

Frühe Nutzung

Belege zu Ferrum

Dokumentation auf GitHub

Technische Berichte

Die veröffentlichten Berichte gehören zu Ferrum.

Grenzen

htsget liefert in Ferrum derzeit ganze Dateien. Abschnitte werden abgelehnt.
Das menschliche Beacon bietet einen Teil der Pfade des Standards an. Es fehlen unter anderem Antworten für Personen und Proben und die drei Zugriffsstufen.
Ein eigener Beacon für Erreger ist beschlossen, aber nicht gebaut.
  • Die verlinkten Unterlagen sagen keine Supportzeiten zu.
  • Das Helm-Chart wurde noch nicht installiert.

Sie möchten die Integration in Ihre Umgebung prüfen?

Integration von Ferrum prüfen