Skip to content

README.md

Latest commit

 

History

History
114 lines (77 loc) · 3.75 KB

README.md

File metadata and controls

114 lines (77 loc) · 3.75 KB

Terraform Provider for PostgreSQL

Fork of Terraform PostgreSQL provider : https://github.com/cyrilgdn/terraform-provider-postgresql

This intent of this fork is to maintain a working version of the provider while waiting for the original repository to be updated.

This repository aims to be up to date with the original one, and also to add some features that are needed for our use cases. We re-integrated the following PRs that were open on the original repository:

This provider allows to manage with Terraform Postgresql objects like databases, extensions, roles, etc.

It's published on the Terraform registry. It replaces https://github.com/hashicorp/terraform-provider-postgresql since Hashicorp stopped hosting community providers in favor of the Terraform registry.

Requirements

  • Terraform 0.12.x
  • Go 1.16 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/cyrilgdn/terraform-provider-postgresql

$ mkdir -p $GOPATH/src/github.com/cyrilgdn; cd $GOPATH/src/github.com/cyrilgdn
$ git clone git@github.com:cyrilgdn/terraform-provider-postgresql

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/cyrilgdn/terraform-provider-postgresql
$ make build

Using the provider

Usage examples can be found in the Terraform provider documentation

Network Mirror

This repository publishes a Terraform provider network mirror on GitHub Pages, allowing you to use this provider without relying on external registries.

Quick setup:

Add to your ~/.terraformrc:

provider_installation {
  network_mirror {
    url = "https://swile.github.io/terraform-provider-postgresql/"
    include = ["registry.terraform.io/cyrilgdn/postgresql"]
  }
}

See the Network Mirror documentation for more details.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

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

$ make build
...
$ $GOPATH/bin/terraform-provider-postgresql
...

In order to test the provider, you can simply run make test.

$ make test

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

In order to manually run some Acceptance test locally, run the following commands:

# spins up a local docker postgres container
make testacc_setup

# Load the needed environment variables for the tests
source tests/switch_superuser.sh

# Run the test(s) that you're working on as often as you want
TF_LOG=INFO go test -v ./postgresql -run ^TestAccPostgresqlRole_Basic$

# cleans the env and tears down the postgres container
make testacc_cleanup