kislerdm / terraform-provider-neon

Terraform provider to manage Neon SaaS resources

Terraform Provider Neon

---

⭐ The project needs your support! Please leave a star and become a GitHub sponsor! ⭐

---

💖 Thank you @neondatabase for sponsoring the project! 💖

---

Terraform provider to manage the Neon Postgres projects.

Using the provider

terraform {
    required_providers {
        neon = {
            source = "kislerdm/neon"
        }
    }
}

provider "neon" {}

Authentication and Configuration

Configuration for the Neon Provider can be derived from several sources, which are applied in the following order:

1. Parameters in the provider configuration

provider "neon" {
  api_key = "<neon-api_key>"
}

2. Environment variables:

• Api key specified as NEON_API_KEY

Requirements

• Terraform >= 0.13.x
• Go >= 1.21

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

$ go install

4. Run to install the provider to be used locally:

make 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.

Developing the Provider

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

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

To generate or update documentation, run go docu.

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