If you're looking for basics for Terra developers, see here.
Job Manager is in maintenance mode and is not recommended for new projects.
dsub support is deprecated and has been removed.
The last release of Job Manager to support dsub without compromise is 1.5.7.
Welcome to the Job Manager repository! If you're a developer you're in the right place.
However, if you just want to try out or deploy Job Manager, you will probably find our user and deployment focused content in our ReadTheDocs pages: https://data-biosphere-job-manager.readthedocs.io/en/latest/
See the development guide below.
The Job Manager is an API and UI for monitoring and managing jobs in a backend execution engine.
The Broad, Verily, and many other organizations in the life sciences execute enormous numbers of scientific workflows and need to manage those operations. Job Manager was born out of the experiences of producing data for some of the world’s largest sequencing projects such as The Cancer Genome Atlas, Baseline, and the Thousand Genomes Project.
The Job Manager aspires to bring ease and efficiency to developing and debugging workflows while seamlessly scaling to production operations management.
- Supports visualization over Cromwell backend
- Service provider interface can be extended to support other engines
- Rich search capabilities across current and historic workflows
- Aborting workflows
- Clean, intuitive UX based on material design principles
The Job Manager defines an API via OpenAPI. An Angular2 UI is provided over the autogenerated Typescript bindings for this API. The UI is configurable at compilation time to support various deployment environments (see environment.ts), including auth, cloud projects, and label columns.
The UI must be deployed along with a backend implementation of the API, two such implementations are provided here:
Monitors jobs launched by the Cromwell workflow engine. The Python Flask wrapper was created using Swagger Codegen and can be configured to pull data from a specific Cromwell instance. At this time, to utilize all job manager features, please consider using Cromwell v32 or newer.
-
Install docker and docker-compose
-
Check out the repository and navigate to the directory:
git clone https://github.com/DataBiosphere/job-manager.git cd job-manager
-
Setup git-secrets on the repository:
- On Mac:
brew install git-secrets
- On Linux:
rm -rf git-secrets git clone https://github.com/awslabs/git-secrets.git cd git-secrets sudo make install && sudo chmod o+rx /usr/local/bin/git-secrets cd .. rm -rf git-secrets
-
Configure the
git secrets
hook:git secrets --install
-
Link your preferred backend docker compose file as
docker-compose.yml
:- Cromwell (local):
ln -sf cromwell-instance-compose.yml docker-compose.yml
- Cromwell (CaaS):
ln -sf cromwell-caas-compose.yml docker-compose.yml
- Cromwell (local):
-
Follow servers/cromwell for Cromwell server setup then return here to continue.
- Run
docker-compose up
from the root of the repository:- If this is the first time running
docker-compose up
this might take a few minutes. - Eventually you should see a compilation success message like this:
jmui_1 | webpack: Compiled successfully.
- If this is the first time running
- Make sure that your Cromwell backend is ready to receive query requests.
- Navigate to http://localhost:4200.
- Websocket reload on code change does not work in docker-compose (see angular/angular-cli#6349).
- Changes to
package.json
,requirements.txt
, orconstraints.txt
regenerating the API require a rebuild with:
docker-compose up --build
Alternatively, rebuild a single component:
docker-compose build ui
- As of 03/31/2023 you'll need to register a
redirectURI
for your application if you've enabled Google OAuth for your JM instance. This is a result of Google deprecating theGoogle Sign-In JavaScript Platform Library
.
- To do so, log in to Google Cloud Platform and go to the
Credentials
page under theAPI & Services
section of the sidebar. - Under
OAuth 2.0 Client IDs
, find the ID used for your JM domain and click the name to go to the edit page. - Under
Authorized redirect URIs
, add the newredirectURI
ashttps://{ORIGIN_NAME}/redirect-from-oauth
(make sure to click the save button after).- Example URI:
https://test-domain.org/redirect-from-oauth
- You'll need to repeat this process if you use a different client ID for each of your domains/environments.
- Example URI:
- NOTE: As a result of the Platform Library deprecation Google is no longer keeping track of active sessions. The authorization flow JM supports (known as the implicit flow) will provide an access_token that lasts for an hour.
- Upon expiration, the applciation will redirect users to the Sign In page again. Simply log back in and you'll be redirected to the page you were previously viewing.
- We use swagger-codegen to transform the API
defined in
api/jobs.yaml
into appropriate classes for the servers and the UI to use. - Whenever the API is updated, run this to trigger a rebuild:
docker-compose up rebuild-swagger
- The
rebuild-swagger
job does nothing if the fileapi/jobs.yaml
has not changed since the last time it was run. - The
rebuild-swagger
job will run by default duringdocker-compose up
to generate the swagger for the other services if necessary. The other services will not start until their swagger classes exist. - After regenerating the model files, you'll need to test and update the server implementations to resolve any broken dependencies on old API definitions or implement additional functionality to match the new specs.
For UI server documentation, see ui.
For cromwell
server documentation, see servers/cromwell.
Starting with release v1.6.0, Job Manager docker images are on GCR.
-
Configure Docker to authenticate with GCR
gcloud config set account username@broadinstitute.org gcloud auth configure-docker us.gcr.io
-
Set the Docker tag first in bash, e.g.
TAG="v0.1.0"
-
To publish the
job-manager-ui
image with$TAG
from the root of this Github repository:docker build -t us.gcr.io/broad-dsp-gcr-public/job-manager-ui:$TAG . -f ui/Dockerfile docker push us.gcr.io/broad-dsp-gcr-public/job-manager-ui:$TAG
-
To publish the
job-manager-api-cromwell
image with$TAG
from the root of this Github repository:docker build -t us.gcr.io/broad-dsp-gcr-public/job-manager-api-cromwell:$TAG . -f servers/cromwell/Dockerfile docker push us.gcr.io/broad-dsp-gcr-public/job-manager-api-cromwell:$TAG
From v1.6.0, each release in Github will also release 2 corresponding Docker images on GCR: