Terraform Provider For StackPath

Website: https://www.terraform.io
Mailing list: Google Groups

Maintainers

This terraform provider plugin is maintained by the Engineering team at StackPath.

Requirements

Terraform 0.10.x+
Go 1.11+ (to build the provider plugin)

Building The Provider

$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone git@github.com:terraform-providers/terraform-provider-template

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-template
$ make build

Installing the provider

After downloading the latest release from GitHub, move the binary into the third party plugin directory on your workstation. Third-party plugins (both providers and provisioners) can be manually installed into the user plugins directory, located at %APPDATA%\terraform.d\plugins\<OS>_<ARCH> on Windows and ~/.terraform.d/plugins/<OS>_<ARCH> on other systems.

Using macOS as an example:

// TODO add curl command for latest release
$ mv ./terraform-provider-stackpath_$VERSION ~/.terraform.d/plugins/darwin_amd64/

Once the plugin has been installed, run terraform init to have terraform discover the StackPath plugin.

Using the provider

Before you can use the StackPath provider, you will need to configure the provider with the stack ID and API credentials that should be used for managing resources. See StackPath's getting started guide for more information on finding your stack ID and API credentials.

provider "stackpath" {
  # only allow version 0.1 of the StackPath provider to be used
  version = "~> 0.1"
  # ID of the stack that resources should be created in
  stack = "{{ stack-id }}"
  # The API credentials that should be used for authentication
  client_id = "{{ client-id }}"
  client_secret = "{{ client-secret }}"
}

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ 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
...
$ $GOPATH/bin/terraform-provider-template
...

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