Skip to content

gordonbondon/terraform-provider-maxminddb

Repository files navigation

terraform-provider-maxminddb

Build status

Terraform provider that helps working with MaxMind GeoIP2 Databases

Using the Provider

For installation instructions and resource documentation check provider page on terraform registry.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements below).

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.

Requirements

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go build command:
$ go build .

To check locally build provider, update dev_overrides cli config:

provider_installation {
  dev_overrides {
    "gordonbondon/maxminddb" = "/path/to/repo/terraform-provider-maxminddb"
  }

  direct {}
}

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

In order to run the full suite of Acceptance tests, run make testacc.

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

$ make testacc

Releasing the Provider

$ fingerprint=$(gpg --with-colons --list-key <key@email> | awk -F: '$1 == "fpr" {print $10;}' | head -n 1)
$ export GPG_FINGERPRINT="${fingerprint}"
$ export GITHUB_TOKEN=xxx
$ git tag v0.x.x -s
$ goreleaser release --rm-dist