Workflow Pipelines User Guide

Difference between a pipeline and a Workflow Pipeline

A Workflow Pipeline can be interpreted as a chain of different pipelines.

A dummy example: How do you put an elephant into a refrigerator? You

1. open the refrigerator door
2. place the elephant inside
3. close the door

In the above example, each step needs the previous step to be successful in order to start current step. put-elephant-in-refrigerator is the Workflow Pipeline, but each step is a single pipeline. There will be 1 Work generated for each of the 3 steps. i.e. there will be 3 pipelines put-elephant-in-refrigerator_open-door, put-elephant-in-refrigerator_place-elephant, and put-elephant-in-refrigerator_close-door accessible in Results at the end of the execution for this Workflow Pipeline.
(No animals were harmed during the production of this technical documentation, esp. no elephants)

Landing Page

When you first access Workflow Web, if you click on the Check out pipelines button, you will be redirected to the Pipelines Landing Page.

The Landing Page contains a row of colorful status indicators, showing the number of Works among different pipelines in different stages.
The search bar below the status indicators can be used to filter on data entries presented in the table; the Select details menu can modify which fields are included in the Work Details.

Pipeline Specific Page

From the landing page, in the left side bar, you will see a list of currently active pipelines for Workflow Pipelines. Clicking on any pipeline will redirect you to the Pipeline specific page in Workflow Pipelines. If you know the pipeline name, its Workflow Pipeline Page can also be accessible at https://frb.chimenet.ca/workflow/pipelines/{pipeline-name}. Please note that the pipeline name must be formatted to kebab-case.

The Pipeline Page contains information similar to the Landing Page: a row of colorful status indicators, showing the number of Works in different stages. The search bar below the status indicators can be used to filter on data entries presented in the table.

Individual Work Page

Clicking on the highlighted Id field in the table shown in the Pipeline Page should redirect you to the individual work page.

The left panel contains some key information about the current Workflow Pipeline such as creation time and status. By default, the Workflow Pipeline Config YAML is displayed to show the pipeline definition (e.g. what work performs at which stage).

Display steps in the Workflow Pipeline

click on the Steps to view a list of Work generated and performed at each stage of the Workflow Pipeline. Click on any highlighted Work ID will redirect you to the Individual Work Page in Results where the work Details, Logs and Pltos are available.