Connecting an Engine

Overview

To run your workflows, Workbench must be connected to an engine.

When you launch a workflow, Workbench submits it to the connected workflow engine. The workflow engine interprets the workflow and generates commands for individual tasks. The engine then dispatches these commands to the cloud or HPC backend through a service that orchestrates computational resources, executes the work, and writes outputs to cloud storage.

To connect Workbench to a workflow engine, you will be prompted to fill out a configuration form using the information provided by the person who deployed the engine (typically your IT administrator).

Workbench currently supports the following combinations of engines and cloud backends:

• On Amazon Web Services (AWS HealthOmics)

• On Google Cloud Platform (Life Sciences API or DNAstack WES)

• On Microsoft Azure (Microsoft CoA or DNAstack WES)

• On-Premises (DNAstack WES)

For more detailed information about the engines and cloud backends, see Deploying an Engine.

Step-by-step instructions

This procedure assumes you have access to a workflow engine deployed on a cloud or on-premises backend, along with the relevant configuration information.

• Step 1: Click "Settings" in the navigation sidebar. This will bring up the Settings page, where any Workflow Engines you have already set up (if any) will be displayed in the table.

• Step 2: Click "Add Engine" button on the top right.

• Step 3: Select the combination of engine and cloud backend you want to connect (e.g. “Cromwell on Google Cloud”). This will bring up the "New Workflow Engine" configuration form.

• Step 4: Fill out the configuration form using the information provided by the person who deployed the engine ( typically your IT administrator) and click "Save".

The newly added engine will be displayed on the Settings page in the Workflow Engines table.