4cb1124dcd | ||
---|---|---|
.github | ||
client | ||
core | ||
examples | ||
githooks | ||
twilio | ||
.gitignore | ||
.goreleaser.yaml | ||
.travis.yml | ||
CHANGES.md | ||
CODE_OF_CONDUCT.md | ||
ISSUE_TEMPLATE.md | ||
LICENSE | ||
Makefile | ||
PULL_REQUEST_TEMPLATE.md | ||
README.md | ||
go.mod | ||
go.sum | ||
main.go | ||
usage.md |
README.md
Twilio Terraform Provider
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
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 git@github.com:twilio/terraform-provider-twilio
Enter the provider directory and build the provider:
make build
Installing and Using the Provider
- Run
make install
to install and build the twilio-terraform-provider. - 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
andTWILIO_AUTH_TOKEN
environment variables. - Add your resource configurations to your Terraform configuration file (e.g. main.tf).
terraform {
required_providers {
twilio = {
source = "twilio/twilio"
version = ">=0.4.0"
}
}
}
# Credentials can be found at www.twilio.com/console.
provider "twilio" {
// account_sid defaults to TWILIO_ACCOUNT_SID env var
// auth_token defaults to TWILIO_AUTH_TOKEN env var
}
resource "twilio_api_accounts_keys_v2010" "key_name" {
friendly_name = "terraform key"
}
output "messages" {
value = twilio_api_accounts_keys_v2010.key_name
}
- Run
terraform init
andterraform apply
to initialize and apply changes to your Twilio infrastructure.
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 withlocal
in your Terraform configuration file (i.e.,source = "local/twilio/twilio"
). Then runterraform 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 ACCOUNT_SID=YOUR_ACCOUNT_SID AUTH_TOKEN=YOUR_AUTH_TOKEN
You can also specify a particular suite to run like so:
make testacc TEST=./twilio/ ACCOUNT_SID=YOUR_ACCOUNT_SID 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.