Manage Pipelines

This article provides a detailed guide on managing pipelines within the Dataloop platform. It covers essential aspects such as save a pipeline as a template, add secrets, reset a pipeline, etc.

Save a Pipeline as a Template

1. Go to the Pipelines from the left-side navigation panel.

2. Identify the pipeline and click on the Pipeline Name. The pipeline page is displayed.

   

3. Click on the Actions and select Save as new template from the list.

4. (Optional) Update the Pipeline name.

5. (Optional) Provide a description for the new pipeline template.

6. Check the following options if needed:

• Configure DPK Variables for Solution Mapping: Set up your template by defining $var(x) in the pipeline variables (limited to datasets and models). These variables will be applied during the solution installation to assign Model or Dataset IDs in the newly created pipeline. For example, to map a solution: dpk.variables = {"x": dpkA.models.yolo8"}.
• Retain Entity-Related Fields (Recommended for Internal Projects): Ensure that fields related to entities, such as dataset ID, model ID, recipe ID, etc., are preserved in the template. This is applicable for nodes related to Tasks, Datasets, and Models. It is recommended for templates intended for use within the same project where the entities originate.
• Preserve Service Configuration and Initialization Input Values: Include any changes to service settings or initialization input values in the template. If not selected, these changes will not be saved, and the settings will revert to their default values. Note that this option does not cover secrets or integrations.

Filtering Data Between Nodes

Hover over a connection between nodes and click the + sign to add a filter. Adding a filter means that only data assets (i.e., items or annotations) that comply with the filter condition will be passed onto the next pipeline node.

Filters can be selected from previously selected filters (saved in the Dataset browser) or written directly into the DQL editor.

For example, the following filter will only pass items whose "size" attribute in the "system" in the "metadata" is less than 1MB:

Remove a filter by hovering over a connection and clicking the X icon (this will sever the connection between the output/input points, and you will need to reconnect the nodes). Alternatively, you remove the filter by setting the filter to an empty JSON { }.

Reset Pipelines

Resetting a pipeline clears all counters, as well as any pending items and cycles, without deleting existing logs or executions.

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Pipeline Name. The pipeline page is displayed.
3. Click on the Actions and select Reset pipeline from the list.

Add Secrets to a Pipeline

Users can configure storage integrations with popular cloud storage services and set up private-registry integrations for more secure and efficient container management. The available types are Key-Value, AWS S3, Google Cloud Storage, Azure Blob, and Google Container Registry.

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click Manage Secrets from the list.
4. Select an existing secrets and integrations from the list, or
5. Click the + icon. The New Integration popup is displayed.
   1. Enter a unique name for your secret.
   2. Enter the secret value that you created at the Data Governance > Secrets page.
   3. Click Create.
6. Click Confirm.

For more information about Dataloop secret, see the Secrets.

Pipeline Cycles

A Pipeline cycle refers to all node executions performed on a single pipeline run (usually over a specific item); the executions are listed in the order in which they occurred. Since some items may be routed differently in the pipeline based on filters and user actions, each cycle may have a different number of executions.

Select a cycle from the list to see its details, including first (node) execution time, last (node) execution time,
Select an execution from the list to see its details, including the function used in the execution, the input, and the output.


Clicking the play button will show the item's progress in the pipeline, highlighting the nodes involved in processing the item.

In the Pipeline Cycle list, click on the number in the Executions column to drill-in and see each execution. This allows you to browse the executions, see the highlighted node on the Pipeline canvas (which enables you to monitor the item’s progress in the pipeline), and see the execution details (input, output, item with item link, execution time, and duration).

Use the Up and Down arrows to browse between the executions and trace the item’s progress over the canvas.

Rerun Pipeline Cycles

Users can rerun pipeline cycles by selecting executions for rerun starting points or entire cycles for rerun to avoid regenerating the cycles again in the case of failure. Rerunning the cycle in the pipeline removes the item status from a task, so it will be reinserted into an assignment.

Pausing a Pipeline with Running Cycles

Once pausing a pipeline with any pending/running cycles, the cycles' status will be updated to "Paused" and the cycles will stop running. When resuming the pipeline, a dialog will open offering two options:

1. Resume all available cycles (pending/in-progress)

2. Abort all available cycles (pending/in-progress) - cycles will get "Terminate" status

   Aborted Cycles

   At the moment, aborted cycles are filtered out automatically from the cycles list in the side panel (can be displayed by filtering cycles with "Terminated" status) and are excluded from the pipeline "statistics bar" counters as well.

If the pipeline was modified while paused and you choose to resume it, the resumed cycles will continue to run according to the new pipeline composition.

Pausing a Pipeline with Active Event triggers

You are provided with the option to keep the pipeline event triggers active when the pipeline is paused, so you won't loose events while editing the pipeline. Please click here to read more.

Errors to Scale Up a Service

Errors occurring in the service restart loop can impact Code/FaaS nodes, potentially hindering the scaling up of the node service. The possible causes can be issues with defined requirements or the specified Docker image. When such errors occur, an indicator will be displayed on the corresponding Pipeline node, along with details about the affected service in the services page of the CloudOps.

• Pipeline service error indication: The error message below appears on the pipeline nodes page during the execution of a pipeline if its associated service has failed.

• Pipeline node error when executing a pipeline with an inactive service: The below error message appears during the execution of a pipeline if its associated service is inactive.

Overcoming Execution Errors

After resolving the root cause for any problem that resulted in failing to execute items (e.g. code problems in packages, insufficient compute resources), you can rerun the execution of failed items

• From the side-panel – select the node, switch to the Executions tab, select the Failed filter option, hover over an item and, click the Rerun button.
• From the CloudOps > Executions page – in the search field, filter by pipeline and by execution.status: failed, and select Rerun All.

Copy Pipeline ID

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click Copy Pipeline ID from the list. The pipeline ID will be copied to the clipboard.

Rename Pipelines

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click Rename Pipeline from the list.
4. Make the update and click Confirm. A confirmation message is displayed.

View Pipeline's Execution Data

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click View Executions from the list. The CloudOps → Executions tab is displayed.

View Pipeline's Log Data

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click View Logs from the list. The CloudOps → Logs tab is displayed.

View Pipeline's Audit Logs

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click View Audit Logs from the list. The Audit Logs page is displayed.

Delete Pipelines

1. Go to the Pipelines from the left-side navigation panel.
2. Identify the Pipeline and click on the Action (three dots) icon.
3. Click Delete Pipeline from the list. A confirmation message is displayed.
4. Click Yes. A confirmation message is displayed.