Caascad/terraform-provider-privx

Terraform Provider PrivX (WIP)

This repository is an unofficial terraform provider for PrivX made by the Caascad team. It uses privx-sdk-go.

Using the provider

See examples (examples/) and generated documentation (docs/),

Development

Requirements

• Terraform >= 1.0
• Go >= 1.20

Optionnal

• Nix >= 2.15.0
• Golangci-lint >= 1.53.3
• Pre-commit >= 3.3.3

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
go mod vendor

Then commit the changes to vendor/, go.mod and go.sum.

Developing the Provider

_This template repository is built on the Terraform Plugin Framework.

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above). You can use Nix to easily get all dependencies:

nix-shell shell.nix

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory. In order to use the built provider for development, add the following $HOME/.terraformrc

provider_installation {

  dev_overrides {
      "privx" = "$GOPATH/bin/"
  }
}

To generate or update documentation, run go generate.

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