Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 3.75 KB

README.md

File metadata and controls

103 lines (72 loc) · 3.75 KB
Raw

Cloudflare Terraform Provider

Requirements

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

Building The Provider

For ease of building the provider, Terraform 0.14 is assumed. Before 0.14, the approaches to using a development binary is difficult and error prone.

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

Once the local repository is present, change into that directory and run make build-dev. This will create a new binary in the same directory which will be loaded for your Terraform operations.

Create the following file in your home directory. Note: This file can live anywhere and isn't restricted to your home directory if you would like it elsewhere.

provider_installation {
  dev_overrides {
    "cloudflare/cloudflare" = "<GOPATH>/src/github.com/cloudflare/terraform-provider-cloudflare"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}

You will need to replace <GOPATH> with the full path to your GOPATH where the repository lives, no ~ shorthand.

Once this is in place, you can run your Terraform operations prefixed with TF_CLI_CONFIG_FILE=/path/to/the/config/file and it will load in your custom overrides. Full details can be found on the Terraform CLI guide.

Migrating to Terraform from using the Dashboard

Do you have an existing Cloudflare account (or many!) that you'd like to transition to be managed via Terraform? Check out cf-terraforming which is a tool Cloudflare has built to help dump the existing resources and import them into Terraform.

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.