Detect and Correct Mod for Flowpipe

Detect and Correct pipeline library for Flowpipe, enabling writing of standardized detect and correct control flows.

Getting Started

Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install flowpipe

Usage

Initialize a mod:

mkdir my_mod
cd my_mod
flowpipe mod init

Install the Detect and Correct mod as a dependency:

flowpipe mod install github.com/turbot/flowpipe-mod-detect-correct

Use the dependency in a pipeline step:

vi my_pipeline.fp

pipeline "my_pipeline" {

  step "pipeline" "resolve_bad_item" {
    pipeline = detect_correct.pipeline.correction_handler
    args = {
      detect_msg      = "Detected an issue on item ${param.item_id}."
      default_action  = "delete_item"
      enabled_actions = ["skip", "delete_item"]
      actions = {
        "skip" = {
          label        = "Skip"
          value        = "skip"
          style        = "info"
          pipeline_ref = detect_correct.pipeline.optional_message
          pipeline_args = {
            notifier = notifier.default
            send     = false
            text     = "Skipped resolving item ${param.item_id}."
          }
          success_msg = ""
          error_msg   = ""
        },
        "delete_item" = {
          label        = "Delete Item"
          value        = "delete_item"
          style        = "alert"
          pipeline_ref = pipeline.delete_item
          pipeline_args = {
            item_id = param.item_id
          }
          success_msg = "Deleted ${param.item_id}."
          error_msg   = "Error deleting ${param.item_id}"
        }
      }
    }
  }
}

Run the pipeline:

flowpipe pipeline run my_pipeline

Open Source & Contributing

This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!

Flowpipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #flowpipe on Slack →

Want to help but not sure where to start? Pick up one of the help wanted issues: