terraform-provider-qwilt

README

Qwilt Terraform Provider

Requirements

• Terraform >= 1.0
• Go >= 1.20

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

Developing the Provider

Configure ~/.terraformrc with the name of your provider and Go installation. For example:

provider_installation {

  dev_overrides {
      "qwilt.com/qwiltinc/qwilt" = "/path/to/binary/of/qwilt/provider"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, so no other providers will be available.
  direct {}
}

Set the local provider name in main.go:

providerName = "qwilt.com/qwiltinc/qwilt"

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 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. Don't run them on a production environment.

make testacc

Releasing the Provider to public registry

In order to release a new version, you must tag branch main with a new version (based on the latest one). Ones a new git tag is pushed, a GitHub Action is executed and creates a new release in 'Draft' mode. Then from github release page you can 'publish release'. Once this is done, terraform-public-registry will detect this release as the latest version.