Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 3.29 KB

architecture.md

File metadata and controls

45 lines (32 loc) · 3.29 KB

Orderly architecture

architecture

Core components

  • orderly - the reproducible analysis engine which manages running reports, tracking all inputs & outputs, archiving and retrieval of old versions, dependencies between analyses
  • reports directory - a version controlled set of orderly reports/analyses. Stores here an archive of previously run reports and a database containing details of run reports. The archive and database will be different between local and remove but the local archive can pull down reports from the remote archive. This is configured per deployment.
  • orderlyweb - R package which manages interaction with remote from local R session including running reports, pulling from the remote archive and running batches
  • Orderly-web browser client - the orderly-web web page running in users browser
  • Orderly-web - back end client running on the server which handles requests from R client and from web app. Can run jobs via orderly.server or read data straight from the archive or orderly database to return to user
  • orderly.server - API which exposes orderly features to Orderly-web. Can return info syncronously e.g. about the state of git in the report directory, or can run jobs async via queue e.g. running a report
  • redis queue - queue stored in redis, managed from orderly.server using rrq
  • orderly-web-deploy - deployment tool
  • orderly-web-py - python client for orderly-web

Additional components

  • orderly-demo - demo orderly repo used for testing
  • orderly.sharepoint - Alternative to orderly-web remote a particular orderly project could use sharepoint to store a remote archive. This is less feature rich than orderly-web remote.
  • orderly.rstudio - Provides RStudio addins for orderly

Deployment configuration

Each specific deployment will have a

  • reports directory github repo
  • deployment configuration used by orderly-web-deploy to sets things like URLs, environment variables, docker container names, vault address, github repo containing reports directory etc.

and optionally can define

  • docker container built from orderly.server container which adds specific R packages and libs needed for that project

Projects

montagu

Note for montagu we also have montagu-r which sits between orderlyweb and Orderly and handles authenticating the R Client using Orderly-web credentials.

ncov