Project

General

Profile

Actions

Idea #19132

open

Registered workflow improvements

Added by Peter Amstutz over 2 years ago. Updated 29 days ago.

Status:
In Progress
Priority:
Normal
Assigned To:
-
Target version:
-
Start date:
09/01/2023
Due date:
03/31/2025 (Due in about 4 months)
Story points:
-
Release:
Release relationship:
Auto

Description

Improve UX around registered workflows.

Better picking

  • Metadata about workflow purpose and function
  • Faceted search

Better launching

  • Change flow so that the user picks a project then a "draft" state container request is created, where the inputs and arvados-cwl-runner options are editable.

Support versioning for registered workflows in Workbench.

Possible features:

  • When launching a workflow, user can choose among multiple versions
  • Can easily determine which version of the workflow was used to run a particular pipeline.
  • Text of workflow that is used for execution is more like the text that the user started from (instead of workflow packing).
  • Text of workflow as submitted (i.e. original) is also saved so that users can compare the "original" they submitted against their VCS later (good for auditability).
  • Requirement from customer: when making a copy, record the upstream collection it was copied from, indicate in the user interface that the upstream version has changed, offer to bump up to current version.

Possible design:

  • Store CWL in a collection with "type: workflow" property
  • Use collection versioning
  • Store workflow metadata in properties
    • entry point
    • input spec
    • git commit/branch/repo? if uploaded a git directory
    • docker jobs image to use
  • Deprecate "workflow" records
  • Identify the workflow version used for a given pipeline by matching the PDH

Implementation:

  • arvados-cwl-runner support for creating/updating new-style registered workflows
  • Workbench 2 support (this is probably the majority of the work)
    • picking
    • viewing
    • launching

Proposed new behavior for a-c-r: always create a workflow collection when running a workflow, so we have accessible record of what was run.


Related issues

Related to Arvados - Idea #19464: record git information when registering a workflowResolvedPeter Amstutz09/08/2022Actions
Related to Arvados - Idea #19636: Editing inputs on "draft" tasksNewActions
Related to Arvados - Idea #20981: Visual design for projects, search, and workflow pickingResolvedPeter Amstutz10/25/2023Actions
Related to Arvados - Idea #20924: Search supports workflowsNewActions
Related to Arvados - Feature #21074: Migrate "workflow" table to be backed by collections but maintain APINewActions
Related to Arvados - Feature #21292: New workflow picker panelNewActions
Related to Arvados - Feature #20880: Can link to wb2 URL to prompt user to launch workflow, specify project uuid in queryNewStephen SmithActions
Related to Arvados - Bug #15814: Running a workflow from WB2 exposes secret inputsResolvedPeter AmstutzActions
Related to Arvados - Feature #20929: Launching workflow creates a draft process for editingNewActions
Related to Arvados - Idea #3094: No UI to edit runtime constraints for draft container requestsNewActions
Related to Arvados - Idea #21709: CWL hints for ordering and grouping inputs which affects WB2 displayNewActions
Related to Arvados - Feature #21710: Render HTML in CWL 'label' and 'doc' fieldsNewActions
Related to Arvados - Feature #21711: CWL File picker option to directly upload files, create and select new collectionNewActions
Related to Arvados - Feature #14168: [Running a workflow] Input presetsNewActions
Related to Arvados - Feature #19086: Can provide input JSON/YAML when launching a Workflow as an alternative to the input formNewPeter AmstutzActions
Actions

Also available in: Atom PDF