In short
Ferrum is a GA4GH gateway in Rust. It runs as an edge build on one computer, or as the full build with a database, object storage and a sign-in service. Early use, Apache 2.0.
Structure
On the left, your organisation with storage, sign-in and the approval service. In the middle, Ferrum with the interfaces. On the right, the partner. Arrows 1 to 5 are operation, finding, request, decision and delivery.
Your organisation
- Storage for your files
- Sign-in
- Approval service, decides
Ferrum
- Standard interfaces
- checks the release
- delivers the file
- Log
Partner
- finds
- asks
- downloads
- 1 Organisation runs it
- 2 Partner finds it
- 3 Request
- 4 Organisation decides
- 5 File is delivered
ferrum-gateway
Storage, sign-in, release (of access)
Log and time
Interfaces and standards
The source of the full build contains seven interfaces. Code that exists is not an end-to-end test.
| Interface | What it means | Build | State |
|---|---|---|---|
| DRS | a standard for finding and fetching files | both | in the source |
| WES | a standard for running analysis workflows | full build only | in the source |
| TES | a standard for running analysis workflows | full build only | in the source |
| TRS | a standard for registering analysis tools | full build only | in the source |
| htsget | a standard for fetching sequencing files. In Ferrum today, whole files | both | whole files today |
| Beacon | asks whether a variant occurs, without showing the data | both | part of the paths |
| Crypt4GH | an encryption format for genomic files | both | in the source |
| Passports | a standard for showing who may access what. The full build includes them from this program. With external sign-in, the log names ga4gh-infra | full build, from this program | not in Edge |
Components in operation
| Component | What it is for | State |
|---|---|---|
| Postgres | the database of the full build | full build |
| SeaweedFS | the object storage of the full build | full build |
| Keycloak | the sign-in system of the full build | full build |
| Docker | a path for starting a program with its dependencies | no Docker |
| Kubernetes | an environment that runs many computers as one | It has not been installed yet. |
| Helm | a package format for Kubernetes. The chart is included and has not been installed | It has not been installed yet. |
Operation
Security
Tests and evidence
Licence
Maturity
Documentation on GitHub
Technical reports
The published reports belong to Ferrum.
- Report series
- SF-TR-2026-001, architecture
- SF-TR-2026-002, Field and Edge
- White paper
- DOI of the first report
- DOI of the second report
Limits
- The linked documents do not state support hours.
- The Helm chart has not been installed.