Terraform Provider for Planetscale

This is an unofficial Terraform provider for Planetscale built using the new Terraform Plugin Framework 🔥

Provider documentation: https://registry.terraform.io/providers/koslib/planetscale/latest/docs

Getting started

Add this provider in your terraform configuration block:

terraform {
  required_providers {
    planetscale = {
      source = "koslib/planetscale"
      version = "~> 0.5"
    }
  }
}

# Configure the planetscale provider
provider "planetscale" {
  service_token_id = "<my-service-token-id>"
  service_token    = "<my-service-token>"
}

See the following section for more quick examples as well as the /examples directory for more detailed demonstrations.

Examples

This provider focuses in being efficient and getting-the-job-done as easy as possible.

The following is a very simple demonstration of an example use of this provider for typical use-cases with Planetscale:

# Create a database
resource "planetscale_database" "this" {
  organization = "my-awesome-org"
  name         = "test-from-tf"
}

# List databases in your organization
data "planetscale_databases" "all" {
  organization = "my-awesome-org"
}

# Output the values of the databases fetched in the data source above
output "list_databases" {
  value = data.planetscale_databases.all
}

# A useful data source for fetching all regions enabled for you organization
data "planetscale_regions" "all" {}

# Create a database branch
resource "planetscale_database_branch" "this" {
  organization = planetscale_database.this.organization
  database     = planetscale_database.this.name
  name         = "my-tf-branch"
}

# Create a database branch password
resource "planetscale_database_branch_password" "my-user" {
  organization = planetscale_database.this.organization
  database     = planetscale_database.this.name
  branch       = planetscale_database_branch.this.name
  name         = "my-staging-env"
}

More examples can be found in the /examples directory.

Development

This provider has been based on the awesome work Planetscale has done with their Golang SDK.

Planetscale API docs can be found here.

Contributing

Please use this provider and test this out in all possible scenarios! The main drive behind making this Terraform provider was to enable the use of Planetscale in an as automated as possible manner.

Please open Issues for any problem you face or if you got an idea for an improvement - or just need help!

Being more technical? PRs are welcome!

Interested in becoming a maintainer in this Github repository? Get in touch!

Docs

Docs can be generated automatically with

go generate ./...

Some points to remember and enhance potentially in future releases:

The /examples path contains examples for both data-sources and resources that will end up in the documentation generated.
The Schema in the resources and data-sources need to contain a Description so that the fields appearing in the documentation can actually make sense.

Known limitations/issues

Resources updates: the Planetscale Golang SDK, on which this Terraform provider heavily relies on, does not support update operations everywhere. This means configuration of resources is not always successful.
Data sources filtering: the filters supported are the filters supported by the Planetscale Golang SDK. More filters will be added as soon as the SDK offers support for them.
No import functionality yet.

Licence

MIT License

See the full licence here.

koslib / terraform-provider-planetscale