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.
Read the documentation for the configuration, the API, access
control, the deployment with the Helm chart in deployment/,
operations, upgrades and development.
| 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.
With Git (tested with 2.17.1) and Docker with the Compose plugin (version 2) installed, clone the repository and start the registry with its MongoDB database:
git clone https://github.com/elixir-cloud-aai/cloud-registry.git
cd cloud-registry
docker compose up --build -dThe API is then served at http://localhost:8080/ga4gh/registry/v1/, with a
Swagger UI at
http://localhost:8080/ga4gh/registry/v1/ui:
curl -X GET "http://localhost:8080/ga4gh/registry/v1/services" -H "accept: application/json"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.
Contributions are welcome! See CONTRIBUTING.md and
Contributing in the documentation, and mind our code of
conduct.
