Usher is the access enforcement system for the Overture platform, the enforcement half of its access control plane. It holds the grants that say what each person may see and do, hands them to each application, and gives the people who govern access one place to change them. It is closer to a keychain than a lock, with the keys handed to each application rather than to the person asking: enforcement happens inside the application at its own query layer, with no per-request call back to Usher.
Two things separate it from a conventional authorization service. It governs who may grant, not only who may read, so a category's custodian holds authority over that category across every dataset while holding no access to any of it. And it fails closed: an application that loses contact with Usher past a short grace period suspends every grant rather than coasting on its cache, and serves only what is open to everyone, as it last held it.
Usher is not an authentication service. Authentication is delegated to the configured identity provider (Keycloak, Microsoft Entra ID, or any OIDC-compatible provider).
Usher is part of Overture, a collection of open-source software microservices used to create platforms for researchers to organize and share genomics data.
These explain the problem and the model, and how to deploy the Controller. The design behind them is in the Design Index.
| Document | For |
|---|---|
| Onboarding | A plain-language orientation to the model and the reasoning behind it, written for readers who are not engineers. Rendered and published as a shared page; the file itself is the source |
| Data access control | The problem and the patterns, before the design detail |
| Why Usher | Why a separate service, rather than access logic inside each application |
| Concepts and vocabulary | RABAC terms, security primitives, and the permissions model entities |
| IAM primer | Login, tokens and access control basics, for readers meeting them for the first time |
| Deploying the Controller | For an operator: the steps of a first deployment, every variable the Controller reads, its database roles, the identity provider's setup, the schema migration before each rollout, registering applications and resources, and its health endpoints |
For internal contributor documentation (project structure, working documents, AI tooling, security principles), see DEVELOPMENT.md.
The Overture platform includes the following components:
| Software | Description |
|---|---|
| Score | Transfer data to and from any cloud-based storage system |
| Song | Catalogue and manage metadata associated to file data spread across cloud storage systems |
| Maestro | Organizing your distributed data into a centralized Elasticsearch index |
| Arranger | A search API with reusable UI components |
| Stage | A React-based web portal scaffolding |
| Lyric | A model-agnostic, tabular data submission system |
| Lectern | Schema Manager, designed to validate, store, and manage collections of data dictionaries |
If you'd like to get started using our platform check out our quickstart guides
Usher is not yet accepting external contributions; the project is in the design phase.
- Platform-level discussions: Overture community support
- Contribution guidelines when available: Contributing Guide
Overture is supported by grant #U24CA253529 from the National Cancer Institute at the US National Institutes of Health, and additional funding from Genome Canada, the Canada Foundation for Innovation, the Canadian Institutes of Health Research, Canarie, and the Ontario Institute for Cancer Research.