diff --git a/docs/using/flowpipe/executions.md b/docs/using/flowpipe/executions.md index e6a3e3d..451c67d 100644 --- a/docs/using/flowpipe/executions.md +++ b/docs/using/flowpipe/executions.md @@ -5,7 +5,7 @@ sidebar_label: Executions # Executions -The **Executions** tab provides visibility into the Flowpipe pipeline and triggers executions. You can view the status of running and completed processes and view the logs. +The **Executions** tab provides visibility into the Flowpipe pipeline and triggers executions. You can view the status of running and completed processes and view their logs. To view your activity, navigate to your workspace. From the **Pipes** tab, select **Flowpipe**, then go to the **Executions** tab. diff --git a/docs/using/flowpipe/index.md b/docs/using/flowpipe/index.md index b61a68f..e38cad4 100644 --- a/docs/using/flowpipe/index.md +++ b/docs/using/flowpipe/index.md @@ -5,8 +5,8 @@ sidebar_label: Flowpipe # Flowpipe -Your workspace includes a hosted [Flowpipe](https://flowpipe.io) instance. Flowpipe is a workflows as code that enables you to automate cloud operations. +Your workspace includes a hosted [Flowpipe](https://flowpipe.io) instance. Flowpipe is a workflow-as-code tool that enables you to automate cloud operations. After you install mods into your workspace, their pipelines will be available to run. You can run them on demand or set up triggers to run them automatically on a schedule or in response to events. -Once your workspace has been created, your Flowpipe server automatically available. Your Flowpipe pipelines can connect to your Steampipe instance, and all the connections in your workspace are available to your Flowpipe pipelines. +Once your workspace has been created, your Flowpipe server is automatically available. Your Flowpipe pipelines can connect to your Steampipe instance, and all the connections in your workspace are available to your Flowpipe pipelines. diff --git a/docs/using/flowpipe/mods.md b/docs/using/flowpipe/mods.md index 40beaca..417d46d 100644 --- a/docs/using/flowpipe/mods.md +++ b/docs/using/flowpipe/mods.md @@ -10,7 +10,7 @@ Flowpipe pipelines are defined in [mods](https://flowpipe.io/docs/build). You c ## Viewing Installed Mods -You can view the mods that are installed in your workspace from the **Mod** tab for the Flowpipe service in your workspace. Navigate to your workspace, then the the **Pipes** tab, and choose **Flowpipe**. The **Mods** tab will list the mods that you have installed, as well as information about the version or branch that is installed. You can type a search string or filter in the **Query** box to filter the list. +You can view the mods that are installed in your workspace from the **Mod** tab for the Flowpipe service in your workspace. Navigate to your workspace, then to the **Pipes** tab, and choose **Flowpipe**. The **Mods** tab will list the mods that you have installed, as well as information about the version or branch that is installed. You can type a search string or filter in the **Query** box to filter the list. ![](/images/docs/pipes/flowpipe/flowpipe_mod_list.png) @@ -43,7 +43,7 @@ You can install mods from the Flowpipe **Mods** tab of your workspace. On the ** Choose the **Integration** that hosts the repo for the mod you wish to install, then select the **Mod Repo** from the dropdown list. -Choose the **Branch or Version Constraint** for the mod. Unlike recommended mods which are only updated once a day, custom mods from integrations are updated in Pipes whenever the source repository is modified. +Choose the **Branch or Version Constraint** for the mod. Unlike recommended mods, which are only updated once a day, custom mods from integrations are updated in Pipes whenever the source repository is modified. When finished, click **Install Mod**. @@ -56,7 +56,7 @@ You can install a mod from *any* public GitHub repo by clicking on **Install fro - The repo must be publicly hosted on GitHub. - There must be at least [one semver tag](https://devhints.io/semver) (not a - pre-release) satisfying the provided semver constraint. + pre-release) satisfying the provided semver constraint. - The tagged version must contain a `mod.fp` file at the root of the repo. The default of `*` means that the latest tagged version will @@ -74,7 +74,7 @@ After the mod is installed, you will be prompted to [set its variables](#managin When you install a mod in a workspace, any [variables](https://flowpipe.io/docs/build/mod-variables) that the mod uses will be visible in Turbot Pipes. -Go to the Flowpipe **Mods** tab for your workspace. From the list of installed mods, click the mod you wish to view/manage the variables for. +Go to the Flowpipe **Mods** tab for your workspace. From the list of installed mods, click the mod for which you wish to view/manage variables. ![](/images/docs/pipes/flowpipe/flowpipe_mod_variables.png) @@ -83,7 +83,7 @@ with a section per variable. You'll see the current value and can edit this and **Save** if you are an owner of the workspace. Depending on the type of the variable, the editor will change, but you'll -typically see either a text, a number or a text/number list editor that will +typically see either a text, a number, or a text/number list editor that will allow you to easily manage the value. Once you've saved a mod variable, this should take effect in your workspace @@ -95,7 +95,7 @@ You can delete a workspace from its detail view. From the list of installed mods ![](/images/docs/pipes/flowpipe/flowpipe_mod_settings.png) -In the detail screen that's shown, scroll to the bottom and click **Uninstall Mod**. Follow the confirmation instructions in the modal and the mod will be uninstalled from your workspace. +In the detail screen that's shown, scroll to the bottom and click **Uninstall Mod**. Follow the confirmation instructions in the modal, and the mod will be uninstalled from your workspace. -After this has completed, you'll no longer see any pipelines for this mod in +After this has been completed, you'll no longer see any pipelines for this mod in the **Pipelines** tab. diff --git a/docs/using/flowpipe/pipelines.md b/docs/using/flowpipe/pipelines.md index 4b3541c..141045e 100644 --- a/docs/using/flowpipe/pipelines.md +++ b/docs/using/flowpipe/pipelines.md @@ -11,7 +11,7 @@ A [Flowpipe pipeline](https://flowpipe.io/docs/flowpipe-hcl/pipeline) is a seque ## 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. +You can view and run pipelines from the **Pipelines** tab for the Flowpipe service in your workspace. Navigate to your workspace, then to 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. ![](/images/docs/pipes/flowpipe/flowpipe_pipelines_list.png) @@ -24,7 +24,7 @@ Clicking on a pipeline will take you to the pipeline detail page. ![](/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. +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 as 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. ## Running a Pipeline @@ -34,14 +34,14 @@ You can run a Flowpipe pipeline by clicking the **Run Pipeline** button from the ![](/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. +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) ## 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 the pipeline's detail page. +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. Alternatively, you can click the **Run Pipeline** dropdown and select **Create Trigger** from the pipeline's detail page. You will be prompted for any parameters. @@ -57,11 +57,6 @@ 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**. -A schedule trigger will be created, and you are redirected to the trigger detail page. +A schedule trigger will be created, and you will be redirected to the trigger detail page. ![](/images/docs/pipes/flowpipe/flowpipe_schedule_trigger_detail.png) - - - - - diff --git a/docs/using/flowpipe/triggers.md b/docs/using/flowpipe/triggers.md index 7226725..fec6359 100644 --- a/docs/using/flowpipe/triggers.md +++ b/docs/using/flowpipe/triggers.md @@ -5,12 +5,12 @@ sidebar_label: Triggers # Triggers -You can set up triggers to run your pipelines automatically, A [Flowpipe trigger](https://flowpipe.io/docs/flowpipe-hcl/trigger) is a mechanism to execute a pipeline automatically when an event occurs. Triggers may be included in [mods](/pipes/docs/using/flowpipe/mods), but you can also create and delete your own triggers in Pipes. +You can set up triggers to run your pipelines automatically. A [Flowpipe trigger](https://flowpipe.io/docs/flowpipe-hcl/trigger) is a mechanism that executes a pipeline automatically when an event occurs. Triggers may be included in [mods](/pipes/docs/using/flowpipe/mods), but you can also create and delete your own triggers in Pipes. ## Viewing Triggers -You can view and manage triggers from the **Triggers** tab for the Flowpipe service in your workspace. Navigate to your workspace, then the the **Pipes** tab, and choose **Flowpipe**. Go to the **Triggers** tab. +You can view and manage triggers from the **Triggers** tab for the Flowpipe service in your workspace. Navigate to your workspace, then to the **Pipes** tab, and choose **Flowpipe**. Go to the **Triggers** tab. ![](/images/docs/pipes/flowpipe/flowpipe_triggers_list.png) @@ -25,7 +25,7 @@ Clicking on a trigger title or the corresponding gear icon will take you to the ## Creating a Trigger -You can create a a trigger by clicking the **New Trigger** button on the Flowpipe **Triggers** tab for your workspace. +You can create a trigger by clicking the **New Trigger** button on the Flowpipe **Triggers** tab for your workspace. First, select the pipeline to run. Click **Next**. @@ -46,24 +46,22 @@ You can also [create triggers from the **Pipelines** tab](/pipes/docs/using/flow ## Editing a Trigger -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 title or gear icon from the list on the **Triggers** tab. You can also navigate to the trigger detail from the **Pipelines** tab by clicking the trigger from the **Triggers** column next a pipeline. +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 title or gear icon from the list on the **Triggers** tab. You can also navigate to the trigger detail from the **Pipelines** tab by clicking the trigger from the **Triggers** column next to a pipeline. ![](/images/docs/pipes/flowpipe/flowpipe_schedule_trigger_detail.png) -The trigger detail page provides extended information about the trigger, including the last run status, name, description, tags, and information about who created it and when. You can also see a list of pipelines that the trigger is configured to run, as well a link to the process logs for all executions of the trigger. +The trigger detail page provides extended information about the trigger, including the last run status, name, description, tags, and information about who created it and when. You can also see a list of pipelines that the trigger is configured to run, as well as a link to the process logs for all executions of the trigger. You can edit the trigger **Title**, **Description**, or **Frequency** (schedule) as well as the pipeline **Args**. Click the pencil icon next to the field to edit it. -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. +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. ## Deleting a trigger -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 title or gear icon from the list on the **Triggers** tab. You can also navigate to the trigger detail from the **Pipelines** tab by clicking the trigger from the **Triggers** column next a pipeline. +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 title or gear icon from the list on the **Triggers** tab. You can also navigate to the trigger detail from the **Pipelines** tab by clicking the trigger from the **Triggers** column next to a pipeline. At the bottom right, click **Delete Trigger** to delete. You will be prompted to confirm deletion. 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). - - diff --git a/docs/using/index.md b/docs/using/index.md index cf0c716..02cc714 100644 --- a/docs/using/index.md +++ b/docs/using/index.md @@ -8,17 +8,6 @@ sidebar_label: Using Pipes Turbot Pipes is a platform built for DevOps that provides intelligence, automation, and security for cloud infrastructure built on [Steampipe](/pipes/docs/using/steampipe/), [Powerpipe](/pipes/docs/using/powerpipe/), and [Flowpipe](/pipes/docs/using/flowpipe/). - - -