NetBird Terraform Provider

A Terraform Provider for managing your NetBird Account and its resources.

Requirements

• Terraform >= 1.0
• Go >= 1.23
• NetBird Account

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.

Using the provider

Check usage in docs.

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 generate.

There are two test suites, separated by the e2e build tag.

make test runs everything that needs nothing but Go — the conversion functions each resource maps its API type through, the filter matching every data source scores on, and the provider's own configuration. It takes about a second and needs no Docker and no Terraform CLI, because the acceptance tests and the harness that starts a deployment for them are not compiled into that build at all.

make testacc runs the acceptance suite as well, against a live NetBird deployment that the harness brings up. It needs Docker and a Terraform CLI.

make test      # fast: no deployment
make testacc   # everything, against a deployment

Both switches in testacc are load-bearing: -tags e2e compiles the harness and the acceptance tests in, and TF_ACC=1 is terraform-plugin-testing's own gate. Dropping either one runs the fast suite and reports success without having tested a deployment.

Note: Acceptance tests create real resources, and often cost money to run against a hosted NetBird instance.