Skip to content

Latest commit

 

History

History
164 lines (112 loc) · 6.45 KB

README.md

File metadata and controls

164 lines (112 loc) · 6.45 KB
Raw

Twilio Terraform Provider

Tests GitHub release (latest by date including pre-releases) Terraform Registry

Project Status

⚠️ This project is currently in PILOT and under active development. If you would like to participate in the pilot, please sign up for Twilio Insiders.

Requirements

  • Terraform v0.15.x
  • Go 1.15+ (to build the provider plugin)

Resource Documentation

Documentation on the available resources that can be managed by this provider and their parameters can be found here.

Note that file upload resources are currently not available.

Building The Provider

Clone repository:

git clone [email protected]:twilio/terraform-provider-twilio

Enter the provider directory and build the provider:

make build

Installing and Using the Provider

  1. Run make install to install and build the twilio-terraform-provider.
  2. Configure the Twilio provider with your twilio credentials in your Terraform configuration file (e.g. main.tf). These can also be set via TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN environment variables.
  3. Add your resource configurations to your Terraform configuration file (e.g. main.tf).
terraform {
  required_providers {
    twilio = {
      source  = "twilio/twilio"
      version = "0.10.0"
    }
  }
}

# Credentials can be found at www.twilio.com/console.
provider "twilio" {
  //  username defaults to TWILIO_API_KEY with TWILIO_ACCOUNT_SID as the fallback env var
  //  password  defaults to TWILIO_API_SECRET with TWILIO_AUTH_TOKEN as the fallback env var
}

resource "twilio_api_accounts_keys_v2010" "key_name" {
  friendly_name = "terraform key"
}

output "messages" {
  value = twilio_api_accounts_keys_v2010.key_name
}
  1. Run terraform init and terraform apply to initialize and apply changes to your Twilio infrastructure.

Using environment variables

You can use credentials stored in environment variables for your setup:

OPTION 1 (recommended)

  • TWILIO_ACCOUNT_SID = your Account SID from your console
  • TWILIO_API_KEY = an API Key created in your console
  • TWILIO_API_SECRET = the secret for the API Key (you would have received this when you created an API key)
  • (optional) TWILIO_REGION = the Region for the account

OPTION 2

  • TWILIO_ACCOUNT_SID = your Account SID from your console
  • TWILIO_AUTH_TOKEN = your Auth Token from your console
  • (optional) TWILIO_REGION = the Region for the account

Examples

For usage examples, checkout the documentation in usage.md and the examples folder.

Developing the Provider

The boilerplate includes the following:

  • Makefile contains helper functions used to build, package and install the Twilio Terraform Provider. It's currently written for MacOS Terraform provider development, but you can change the variables at the top of the file to match your OS_ARCH.

    The install function is configured to install the provider into the ~/.terraform.d/plugins/ folder. To use the locally installed provider, prefix the source path with local in your Terraform configuration file (i.e., source = "local/twilio/twilio"). Then run terraform init to use the locally built provider.

  • examples contains sample Terraform configuration that can be used to test the Twilio provider

  • twilio contains the main provider code. This will be where the provider's resources and data source implementations will be defined.

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.15+ is required).

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-twilio
...

In order to run the full suite of Acceptance tests, run make testacc. Provide your Account SID and Auth Token as environment variables to properly configure the test suite.

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

 make testacc TWILIO_ACCOUNT_SID=YOUR_ACCOUNT_SID TWILIO_AUTH_TOKEN=YOUR_AUTH_TOKEN

You can also specify a particular suite to run like so:

 make testacc TEST=./twilio/ TWILIO_ACCOUNT_SID=YOUR_ACCOUNT_SID TWILIO_AUTH_TOKEN=YOUR_AUTH_TOKEN

An example test file can be found here.

Debugging

First:

export TF_LOG=TRACE

then refer to the Terraform Debugging Documentation.

Debugging with Delve

You can build and debug the provider locally. When using Goland you can set break point and step through code:

$ dlv debug main.go -- -debug
Type 'help' for list of commands.
(dlv) c
Provider started, to attach Terraform set the TF_REATTACH_PROVIDERS env var:

	TF_REATTACH_PROVIDERS='{"registry.terraform.io/twilio/twilio":{...}}}'

Copy the TF_REATTACH_PROVIDERS and run Terraform with this value set:

$ TF_REATTACH_PROVIDERS='...' terraform init
$ TF_REATTACH_PROVIDERS='...' terraform plan
...

Terraform will use the binary running under dlv instead of the twilio/twilio registry version. For further details refer to the Terraform Debugging Providers documentation.

Debugging with Goland

  • Set up GOROOT (initially opening main.go should show this option)
  • Select Modify Run Configuration... on main.go and then add --debug as Program arguments
  • Select Debug "go build main.go" and then copy the TF_REATTACH_PROVIDERS to the shell where terraform will be run
  • Set breakpoints in Goland as needed and run terraform, it will use plugin the process running under the Goland debugger