DRS-filer

Synopsis

Microservice implementing the Global Alliance for Genomics and Health (GA4GH) Data Repository Service (DRS) API specification.

Description

Usage

Once deployed, the API is served here:

http://localhost:8080/ga4gh/drs/v1/

Note that host (localhost) and port (8080) in the URL above may differ, depending on how the service was deployed. Indicated values are for docker-compose-based installations using the default [configuration][drs-filer-compose-config].

The easiest way to explore available endpoints is via the [Swagger UI][res-swagger-ui]:

http://localhost:8080/ga4gh/drs/v1/ui

Installation

To quickly install the service for development/testing purposes, we recommend deployment via [docker-compose][res-docker-compose], as described below. For more durable deployments on cloud native infrastructure, we also provide a [Helm][res-helm] chart and [basic deployment instructions][drs-filer- deployment] (details may need to be adapted for your specific infrastructure).

Requirements

The following software needs to be available on your system:

• [git][res-git] v2.17.1
• [docker][res-docker] v18.09.6
• [docker-compose][res-docker-compose] v1.23.1

Indicated versions were used during development. Other versions may work as well, especially newer ones.

Deployment

First, clone the repository and traverse into the service's root directory with:

git clone git@github.com:elixir-cloud-aai/drs-filer.git
cd drs-filer

Then simply start up the service with:

docker-compose up --build -d

That's it!

You should now be able to use/explore the API as described in the usage section.

Other useful commands

To shut down the service, run:

docker-compose down

If you need to inspect the logs, call:

docker-compose logs

Contributing

This project is a community effort and lives off your contributions, be it in the form of bug reports, feature requests, discussions, or fixes and other code changes. Please refer to our organization's contributing guidelines if you are interested to contribute. Please mind the code of conduct for all interactions with the community.

Versioning

The project adopts the semantic versioning scheme for versioning. Currently the service is in beta stage, so the API may change without further notice.

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 Cloud & AAI. 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.