[go: up one dir, main page]

Skip to content

turbot/terraform-provider-pipes

Terraform Turbot Pipes provider

Requirements

  • Terraform 0.10.x
  • Go 1.14 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/turbot/terraform-provider-pipes

$ export GOPATH=$(go env GOPATH)
$ mkdir -p $GOPATH/src/github.com/turbot; cd $GOPATH/src/github.com/turbot
$ git clone git@github.com:turbot/terraform-provider-pipes

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/turbot/terraform-provider-pipes
$ make build

Using the provider

If you're building the provider, follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it.

Further usage documentation is available on the Terraform website.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.8+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build
go build -o bin/terraform-provider-pipes_0.0.1 -ldflags="-X github.com/turbot/terraform-provider-pipes/version.ProviderVersion=0.0.1"

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

Migrating from legacy steampipecloud provider

The new pipes provider is a drop-in replacement for the steampipecloud provider which has been deprecated. We have updated the name of the resources and data sources to prefix with pipes_ instead of steampipecloud_.

Please follow the steps below to migrate your existing Terraform configuration to use the new pipes provider.

  • Your new provider configuration should look like below.
terraform {
  required_providers {
    pipes = {
      source = "turbot/pipes"
    }
  }
}
  • Replace the prefix for all resource name references from steampipecloud_ to pipes_. An example before and after configuration is shown below.
resource "steampipecloud_workspace" "my_test_workspace" {
  handle = "test"
}
resource "pipes_workspace" "my_test_workspace" {
  handle = "test"
}
  • Use terraform import to import your existing resources into the new provider.
terraform import pipes_workspace.my_test_workspace test
  • Use terraform state rm to remove your state file entries that resolved to the old provider.
terraform state rm steampipecloud_workspace.my_test_workspace
  • Run terraform plan to ensure everything is aligned and in sync.