LogoLogo
  • Overview
  • publisher
    • Introduction
    • Getting Started
      • Logging in to Publisher
    • Data Sources
      • Connecting a Data Source
      • Managing a Data Source
      • Connectors
        • AWS S3 Permissions
        • Connecting to AWS S3 Storage
        • Google Cloud Storage (GCS) Permissions
        • Connecting to Google Cloud Storage
        • PostgreSQL Permissions
        • Connecting to PostgreSQL
        • PostgreSQL on Azure Permissions
        • Microsoft Azure Blob Storage Permissions
        • Connecting to Microsoft Azure Blob Storage
        • Connecting to HTTPS
        • Connecting to other sources via Trino
          • BigQuery
    • Collections
      • Creating a Collection
      • Sharing a Collection
      • Collection Filters
      • Editing Collection Metadata
      • Updating Collection Contents
    • Access Policies
      • Creating an Access Policy
      • Managing Access Policies
    • Questions
      • Adding Questions
      • Example Question
    • Settings
      • Viewing Current and Past Administrators
      • Adding an Administrator
      • Removing an Administrator
      • Setting Notification Preferences
  • Explorer
    • Introduction
    • Viewing a Collection
    • Browsing Collections
    • Asking Questions
    • Accessing a Private Collection
      • Requesting Access to a Private Collection
    • Filtering Data in Tables
      • Strings
      • Dates
      • Numbers
  • Workbench
    • Introduction
    • Getting Started
      • Logging into Workbench
      • Connecting an Engine
      • Finding or Importing a Workflow
      • Configuring Workflow Inputs
      • Running and Monitoring a Workflow
      • Locating Outputs
    • Engines
      • Adding and Updating an Engine
        • On AWS HealthOmics
        • On Microsoft Azure
        • On Google Cloud Platform
        • On Premises
      • Parameters
        • AWS HealthOmics
        • Google Cloud Platform
        • Microsoft Azure
        • On-Premises
        • Cromwell
        • Amazon Genomics CLI
    • Workflows
      • Finding Workflows
      • Adding a Workflow
      • Supported Languages
      • Repositories
        • Dockstore
    • Instruments
      • Getting Started with Instruments
      • Connecting a Storage Account
      • Using Sample Data in a Workflow
      • Running Workflows Using Samples
      • Family Based Analysis with Pedigree Information
      • Monitor the Workflow
      • CLI Reference
        • Instruments
        • Storage
        • Samples
        • OpenAPI Specification
    • Entities
    • Terminology
  • Passport
    • Introduction
    • Registering an Email Address for a Google Identity
  • Command Line Interface
    • Installation
    • Usage Examples
    • Working with JSON Data
    • Reference
      • workbench
        • runs submit
        • runs list
        • runs describe
        • runs cancel
        • runs delete
        • runs logs
        • runs tasks list
        • runs events list
        • engines list
        • engines describe
        • engines parameters list
        • engines parameters describe
        • engines health-checks list
        • workflows create
        • workflows list
        • workflows describe
        • workflows update
        • workflows delete
        • workflows versions create
        • workflows versions list
        • workflows versions describe
        • workflows versions files
        • workflows versions update
        • workflows versions delete
        • workflows versions defaults create
        • workflows versions defaults list
        • workflows versions defaults describe
        • workflows versions defaults update
        • workflows versions defaults delete
        • namespaces get-default
        • storage add
        • storage delete
        • storage describe
        • storage list
        • storage update
        • storage platforms add
        • storage platforms delete
        • storage platforms describe
        • storage platforms list
        • samples list
        • samples describe
        • samples files list
      • publisher
        • datasources list
  • Analysis
    • Python Library
    • Popular Environments
      • Cromwell
      • CWL Tool
      • Terra
      • Nextflow
      • DNAnexus
Powered by GitBook

© DNAstack. All rights reserved.

On this page
  • Adding a New Engine
  • Choosing the Right Engine
  • Supported Regions
  • Data Movement and Costs
  • WDL Support
  • Required Configuration
  • Name and ID
  • Provider and Configuration
  • Updating an Engine
  • Engine State

Was this helpful?

  1. Workbench
  2. Engines

Adding and Updating an Engine

PreviousEnginesNextOn AWS HealthOmics

Last updated 2 months ago

Was this helpful?

requires at least one configured engine before you can submit workflow runs. This guide explains how to add and manage your engines.

Adding a New Engine

  1. Navigate to the in Workbench

  2. Click "Add Engine" in the top right corner

  3. Select your engine type:

Choosing the Right Engine

There is no single "right" engine choice - your selection should align with your project needs and available resources. When selecting an engine, consider:

Supported Regions

Different engines have different regional availability. Ensure your chosen engine is available in regions that meet both your compliance and data locality requirements.

Data Movement and Costs

Since data can exist in different regions and cloud environments, consider potential costs of data movement. Choose an engine that can access your data without incurring unnecessary egress costs.

WDL Support

Engines vary in their WDL version support:

  • Cromwell supports WDL 1.0

  • miniWDL and HealthOmics support up to WDL 1.2

Required Configuration

Each engine needs the following metadata:

Name and ID

  • Choose a meaningful name for easy identification

  • Engine IDs must contain only letters, numbers, underscores, and dashes

  • IDs are auto-generated from names but can be customized

  • You'll use the ID for CLI and API references

Provider and Configuration

The specific configuration options depend on your engine type. For example:

  • AWS engines need access and secret keys

  • GCP engines require a service account key

After completing configuration, click "Save." Workbench will validate your settings and perform connectivity checks.

Updating an Engine

Navigate to the Engines page and select the engine you want to modify. You can update the name and configuration, but engine type and ID cannot be changed after creation.

Engine State

Workbench displays engine status on the state card, showing:

  • Overall state (ONLINE or OFFLINE)

  • Last check timestamp

  • Individual check results

  • Detailed error messages for troubleshooting

For help resolving issues, consult your engine's configuration guide.

Workbench
Engines page
Google Cloud Platform
AWS HealthOmics
Microsoft Azure
On-Premises