Consul Terraform Provider

• Terraform Website
• Consul Docs
• Consul Terraform Provider Docs

Maintainers

This provider plugin is maintained by the Consul team at HashiCorp.

Compatibility

The Consul Terraform provider uses features of the latest version of Consul. Some resources may not be supported by older versions of Consul.

The known compatibility between this provider and Consul is:

Terraform provider version	Consul version
2.22.0	>= 1.19.0
2.21.0	>= 1.17.0
2.20.0	>= 1.17.0
2.19.0	>= 1.17.0
2.18.0	>= 1.16.0

Requirements

• Terraform >= 0.13.x
• Go >= 1.15

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

go install

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

Running the tests

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. This should be performed before merging or opening pull requests.

The acceptance test will automatically look for a consul binary in the computer to start a development server. The binary used by the acceptance tests can be specified by setting the CONSUL_TEST_BINARY environment variable.

make testacc

Documentation

Full, comprehensive documentation is available on the Terraform Registry:

https://registry.terraform.io/providers/hashicorp/consul/latest/docs

If you wish to contribute to the documentation, the source can be found in this repository under website/docs/. To preview documentation changes prior to submitting a pull request, please use the Terraform Registry's doc preview tool.