DEVELOPING.md

Development Environment Setup

Requirements

• Terraform >= 0.14
  • We recommend you to use Terraform version manager tfutils/tfenv
    • tfenv install 0.15.3, tfenv use 0.15.3
• Go 1.18 (to build the provider plugin)
  • We recommend you to use Go version manager syndbg/goenv
    • goenv install 1.18.0

Quick Start

To compile the provider, run make build. This will build the provider and put the provider binary in the bin directory.

$ make deps
$ make build

Testing the Provider

The easiest way to run acceptance tests is to use the built in make step testacc:

Note: acceptance tests won't create the actual cloud resources since they will be run against a mock server.

$ make testacc

Using the Provider

With Terraform v0.14 and later, development overrides for provider developers can be leveraged in order to use the provider built from source.

To do this, populate a Terraform CLI configuration file (~/.terraformrc for all platforms other than Windows; terraform.rc in the %APPDATA% directory when using Windows):

provider_installation {
  dev_overrides {
    "terraform.confluent.io/confluentinc/confluent" = "/Users/{REPLACE WITH YOUR PATH}/terraform-provider-confluent/bin/darwin-amd64"
  }

  # Install all other providers directly from their origin provider
  # registries as normal. If you omit this, no other providers will be available.
  direct {}
}