Skip to content

Commit

Permalink
add screenshots to flowpipe pipelines docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 24, 2024
1 parent 44300f6 commit a213b58
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 21 deletions.
36 changes: 15 additions & 21 deletions docs/using/flowpipe/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,23 @@ sidebar_label: Pipelines
# Pipelines


A [Flowpipe pipeline](https://flowpipe.io/docs/flowpipe-hcl/pipeline) is a sequence of steps to do work. Pipelines are distributed in [mods](/pipes/docs/using/flowpipe/mods). You can find mods on the [Flowpipe Hub](https://hub.flowpipe.io/), but you can also [write your own mods](https://flowpipe.io/docs/build) and run them in Pipes.
A [Flowpipe pipeline](https://flowpipe.io/docs/flowpipe-hcl/pipeline) is a sequence of steps to do work. Pipelines are distributed in [mods](/pipes/docs/using/flowpipe/mods) - you must [install one or more Flowpipe mods](/pipes/docs/using/flowpipe/mods#installing-recommended-mods) to run pipelines. You can find mods on the [Flowpipe Hub](https://hub.flowpipe.io/), but you can also [write your own mods](https://flowpipe.io/docs/build) and run them in Pipes.


## Viewing Pipelines

You can view and run pipelines from the **Pipelines** tab for the Flowpipe service in your workspace. Navigate to your workspace, then the the **Pipes** tab, and choose **Flowpipe**. The **Pipelines** tab will list the runnable pipelines for the mods that you have installed, as well as information about any triggers that have been set up, the last time the pipeline has run, and the next time it will run if it has been scheduled. You can type a search string or filter in the **Query** box to filter the list.


SCREEN SHOT.....
![](/images/docs/pipes/flowpipe/flowpipe_pipelines_list.png)



Clicking on a pipeline will take you to the pipeline detail page.


SCREEN SHOT.....
![](/images/docs/pipes/flowpipe/flowpipe_pipeline_detail.png)


The pipeline detail page provides extended information about the pipeline, including the last run status, name, description, tags, and information about who created it and when. You can also see a list of triggers that are configured to run this pipeline, as well a link to the process logs for all runs of the pipeline. From this page you also have the option to run the pipeline or create a trigger for it.

Expand All @@ -29,45 +31,37 @@ The pipeline detail page provides extended information about the pipeline, inclu

You can run a Flowpipe pipeline by clicking the **Run Pipeline** button from the **Pipelines** tab for your workspace or from the pipeline detail page. If the pipeline has parameters defined, you will be prompted for them. Enter the parameter values and click **Run Pipeline**.

SCREEN SHOT.....
![](/images/docs/pipes/flowpipe/flowpipe_pipeline_run.png)
.

The pipeline will be submitted for execution, and you will be redirected to the process page where you can view the logs as the process runs.

![](/images/docs/pipes/flowpipe/flowpipe_pipeline_run_complete.png)


## Managing Triggers
## Scheduling a Pipeline

You can set up triggers to run your pipelines automatically. You can create a trigger from the **Pipelines** list by clicking the clock icon next to the pipeline you wish to trigger. Alternately, you can click the **Run Pipeline** dropdown and select **Create Trigger** from either the **Pipelines** page or the pipeline detail page.

You will be prompted for any parameters.

SCREEN SHOT...

Enter them and click **Next**. You are then prompted for a schedule. Select the desired interval or enter a custom cron schedule and then click **Create**
![](/images/docs/pipes/flowpipe/flowpipe_pipeline_scheduled_params.png)


## Editing triggers
You can enable or disable a trigger or change its frequency from the trigger detail page. To view the trigger detail, you can click on the trigger from the list of pipelines on the **Pipelines** tab or from the trigger list in the pipeline detail page.

SCREEN SHOT...
Enter them and click **Next**. You are then prompted for a schedule.

Like the pipeline detail page, the trigger detail page shows the last run status, name, description, tags, and information about who created it and when, as well as links to **All Runs** to view historical process logs.
![](/images/docs/pipes/flowpipe/flowpipe_pipeline_scheduled_frequency.png)

If the pipeline tags arguments, they will appear as well. Click the pencil icon next to the **Args** to edit them.

The **Details** section will also show the **Frequency**. Click the pencil icon next to the **Frequency** to edit the schedule.
Select the desired interval or enter a custom cron schedule and then click **Create**.

You can also enable, disable or run the trigger from this page. The **Run Now** button will execute the trigger manually. Depending on the state of the trigger there will also be an **Enable** or **Disable** button to change the state.

A schedule trigger will be created, and you are redirected to the trigger detail page.

## Deleting triggers
![](/images/docs/pipes/flowpipe/flowpipe_schedule_trigger_detail.png)

If you created the trigger in pipes, you can delete it from the trigger detail page. To view the trigger detail, you can click on the trigger from the list of pipelines on the **Pipelines** tab or from the trigger list in the pipeline detail page.

At the bottom right, click **Delete Trigger** to delete. You will be prompted to confirm deletion.

SCREEN SHOT...

Click **Delete** to permanently delete the trigger.

Note that triggers that are defined in [mods](/pipes/docs/using/flowpipe/mods) cannot be deleted (but you can disable them).
Binary file added images/flowpipe/flowpipe_pipeline_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/flowpipe/flowpipe_pipeline_run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/flowpipe/flowpipe_pipelines_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a213b58

Please sign in to comment.