terraform-provider-form3

README

Terraform Form3 Provider

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

The Form3 provider is used to create and manage Form3 resources using the official Form3 API

Requirements

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

Building The Provider

Clone repository to: $GOPATH/src/github.com/form3tech-oss/terraform-provider-form3

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/form3tech-oss/terraform-provider-form3
$ make build

Using the provider

See examples

See form3 providers documentation

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.9+ 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-form3
...

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

$ make test

In order to run the full suite of Acceptance tests, set the environment variables listed below and run make testacc.

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

Environment variables	Description
FORM3_HOST	Form 3 host e.g. api.form3.tech
FORM3_ACC	Set to 1 to run integration tests
FORM3_CLIENT_ID	Client id
FORM3_CLIENT_SECRET	Secret
FORM3_ORGANISATION_ID	Organisation Id
TF_LOG	"TRACE", "DEBUG", "INFO", "WARN", "ERROR"

Example

make testacc FORM3_ACC=1 FORM3_CLIENT_ID=xxx FORM3_CLIENT_SECRET=xxx FORM3_HOST=api.whistle.env.form3.tech FORM3_ORGANISATION_ID=xxx

Swagger

To generate the swagger model run: make install-swagger generate-swagger-model