Cloudflare Terraform Provider

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

Requirements

• Terraform 0.12.x
• Go 1.15 (to build the provider plugin)

Building The Provider

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

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

Since Terraform 0.13, all providers (including local ones) require a version and need to meet stricter load conditions. To simplify this there is a make target available which will handle building and putting the executable in the correct place.

make build-and-install-dev-version

Once this completes, you will need to update your Terraform provider configuration to reference version 99.0.0 (the version of the development build) in order to use it. Example configuration:

terraform {
  required_version = ">= 0.13"
  required_providers {
    cloudflare = {
      source = "cloudflare/cloudflare"
      version = "99.0.0"
    }
  }
}

Be sure to remove any additional configuration from your ~/.terraformrc and .terraform directories to prevent load issues. You will also need to update all version references to use 99.0.0 in order to fully initialise the development provider. If you see other versions (like the example below) you need to track them down and remove them.

Finding cloudflare/cloudflare versions matching "99.0.0, ~> 2.*"...

Developing the Provider

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

See above for which option suits your workflow for building the provider.

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

Managing dependencies

Terraform providers use Go modules to manage the dependencies. To add or update a dependency, you would run the following (v1.2.3 of foo is a new package we want to add):

$ go get [email protected]
$ go mod tidy

Stepping through the above commands:

• go get [email protected] fetches version v1.2.3 from the source (if needed) and adds it to the go.mod file for use.
• go mod tidy cleans up any dangling dependencies or references that aren't defined in your module file.

(The example above will also work if you'd like to upgrade to v1.2.3)

If you wish to remove a dependency, you can remove the reference from go.mod and use the same commands above but omit the initial go get.