Skip to content

Latest commit

 

History

History
130 lines (87 loc) · 3.49 KB

README.md

File metadata and controls

130 lines (87 loc) · 3.49 KB
Raw

Azure Mod for Flowpipe

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

Documentation

Getting Started

Requirements

Docker daemon must be installed and running. Please see Install Docker Engine for more information.

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:

  • AZURE_CLIENT_ID
  • AZURE_CLIENT_SECRET
  • AZURE_ENVIRONMENT
  • AZURE_TENANT_ID

You can also create connection resources in configuration files:

vi ~/.flowpipe/config/azure.fpc
connection "azure" "default" {
  client_id     = "<your client id>"
  client_secret = "<your client secret>"
  tenant_id     = "<your tenant id>"
}

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 Azure mod as a dependency:

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

Use the dependency in a pipeline step:

vi my_pipeline.fp
pipeline "my_pipeline" {

  step "pipeline" "list_compute_virtual_machines" {
    pipeline = azure.pipeline.list_compute_virtual_machines
    args = {
      resource_group  = "my-rg"
      subscription_id = "abcdef01-2345-6789"
    }
  }
}

Run the pipeline:

flowpipe pipeline run my_pipeline

Developing

Clone:

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

List pipelines:

flowpipe pipeline list

Run a pipeline:

flowpipe pipeline run create_compute_virtual_machine --arg vm_name='VM Dev' --arg vm_image=Ubuntu2204 --arg subscription_id=1234-5678-9012-3456 --arg resource_group=my-rg

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

flowpipe pipeline run list_compute_virtual_machines --arg conn=connection.azure.azure_prod --arg subscription_id=1234-5678-9012-3456 --arg resource_group=my-rg

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: