Terraform Provider for pfSense

Configure pfSense firewall/router with Terraform. Validated with pfSense CE, compatibility with pfSense Plus is not guaranteed.

Support Matrix

Warning

All versions released prior to v1.0.0 are to be considered breaking changes.

Release	pfSense	Terraform
< v1.0.0	>= 2.6.0, <= 2.7.2	>= 1.7.0

Development Requirements

• Terraform
• Go

Building The Provider

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

go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

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.

To generate or update documentation, run make docs.

In order to run the full suite of Acceptance tests, run make test/acc.

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

make test/acc