Skip to content

Opsgenie pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect Opsgenie to the people, systems and data that matters.

License

Notifications You must be signed in to change notification settings

turbot/flowpipe-mod-opsgenie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Opsgenie Mod for Flowpipe

Opsgenie pipeline library for Flowpipe, enabling seamless integration of Opsgenie services into your workflows.

Documentation

Getting Started

Installation

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

brew tap turbot/tap
brew install flowpipe

Connections

By default, the following environment variables will be used for authentication:

  • OPSGENIE_ALERT_API_KEY
  • OPSGENIE_INCIDENT_API_KEY

You can also create connection resources in configuration files:

vi ~/.flowpipe/config/opsgenie.fpc
connection "opsgenie" "default" {
  alert_api_key    = "<your alert api key>"
  incident_api_key = "<your incident api key>"
}

For more information on connections in Flowpipe, please see Managing Connections.

Usage

Initialize a mod:

mkdir my_mod
cd my_mod
flowpipe mod init

Install the Opsgenie mod as a dependency:

flowpipe mod install github.com/turbot/flowpipe-mod-opsgenie

Use the dependency in a pipeline step:

vi my_pipeline.fp
pipeline "my_pipeline" {

  step "pipeline" "create_alert" {
    pipeline = opsgenie.pipeline.create_alert
    args = {
      message = "Alert from Flowpipe"
    }
  }
}

Run the pipeline:

flowpipe pipeline run my_pipeline

Developing

Clone:

git clone https://github.com/turbot/flowpipe-mod-opsgenie.git
cd flowpipe-mod-opsgenie

List pipelines:

flowpipe pipeline list

Run a pipeline:

flowpipe pipeline run create_alert --arg message="Alert from Flowpipe"

To use a specific connection, specify the conn pipeline argument:

flowpipe pipeline run create_alert --arg message="Alert from Flowpipe" --arg conn=connection.opsgenie.opsgenie_profile

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: