Skip to content
elixir-cloud-aaiPublic

About

Proxy service for injecting middleware into GA4GH Workflow Execution Service (WES) API requests

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

22 watching

Forks

ELIXIR On-Cloud

proWES

License Build_status Docs Coverage

A gateway for the GA4GH Workflow Execution Service (WES) API that federates your WES instances, brought to you by ELIXIR On-Cloud. Clients send their workflow runs to proWES as to any WES instance; proWES forwards each run to a WES instance and tracks its state. It is built with FOCA. Run it with Docker Compose for development and testing; a Helm chart for Kubernetes is in deployment/.

Read the documentation for the architecture, the configuration, the API, the deployment, operations, upgrades and development.

Quick start

With Git and Docker with the Compose plugin (version 2.23.1 or later) installed, clone the repository and start proWES with its MongoDB database, RabbitMQ broker and Celery worker, waiting until their health checks pass:

git clone https://github.com/elixir-cloud-aai/prowes.git
cd prowes
docker compose up -d --build --wait

The WES API is then served at http://localhost:8090/ga4gh/wes/v1/, with a Swagger UI at http://localhost:8090/ga4gh/wes/v1/ui/:

curl -X GET "http://localhost:8090/ga4gh/wes/v1/service-info" -H "accept: application/json"

Citation

If you use proWES, please cite it with the metadata in CITATION.cff: on GitHub, "Cite this repository" in the sidebar of the repository formats it as APA or BibTeX. A DOI follows with the first release archived on Zenodo.

Contributing

Contributions are welcome! See Contributing in the documentation and the organisation's contributing guide, and mind our code of conduct.

About

Proxy service for injecting middleware into GA4GH Workflow Execution Service (WES) API requests

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

22 watching

Forks

Releases

Used by

Contributors

Languages