Cloud Registry¶
A registry of web services for your project, network or infrastructure,
brought to you by ELIXIR On-Cloud. It implements
the GA4GH Service Registry
API, so that
clients can discover your GA4GH services (or any other web services) and
their API types, versions and operators in one place. Service entries comply
with the ExternalService
schema.
Anyone can read them (unless you require login); users logged in with an
OpenID Connect provider that you trust can register services and manage those
they own, and admins can verify them. Run it with Docker Compose or deploy it
to Kubernetes with its Helm chart; a web front
end is available,
too.
Known deployments¶
| Deployment | Operated by | Notes |
|---|---|---|
| https://registry.elixir-on.cloud/ | ELIXIR On-Cloud | With the web front end |
Running the Cloud Registry yourself? Open a pull request that adds your
deployment to the table in
README.md.
Contents¶
- Getting started: run the registry with Docker Compose and send the first requests.
- Configuration: the base config, overlays, public URLs, the request size limit, the server and the service info.
- API: the endpoints, what registrations must look like, errors, duplicate and verified services.
- Access control: authentication with an OpenID
Connect provider, roles of users and groups on services, admins and
GET /me. - Deployment: the Helm chart for Kubernetes.
- Operations: admins, the permissions API, audit logs and verifying images and charts.
- Upgrading: changes to existing deployments and data.
- Development: development setup, checks, versioning and releases.
- Contributing: how to contribute, the code of conduct, pull requests, commit messages and the Python guidelines.
- API reference: the code, generated from its docstrings.
- Changelog: release notes.
Citation¶
If you use Cloud Registry, please cite it with its DOI
10.5281/zenodo.23606856, which
always resolves to the latest version on Zenodo; the
Zenodo record lists the DOI of each version, too. The citation metadata is in
CITATION.cff:
on GitHub, "Cite this repository" in the sidebar of the repository formats it
as APA or BibTeX.
License¶
This project is covered by the Apache License 2.0 also shipped with this repository.
Contact¶
The project is a collaborative effort under the umbrella of ELIXIR On-Cloud. Follow the link to get in touch with us via chat or email. Please mention the name of this service for any inquiry, proposal, question etc.