terraform-provider-timescale

README

Timescale Terraform Provider

The Terraform provider for Timescale.

Does not work for Managed Service for TimescaleDB.

Requirements

• Terraform >= 1.0

Quick Start

Authorization

When you log in to your Timescale Account, navigate to the Project settings page. From here, you can create client credentials for programmatic usage. Click the Create credentials button to generate a new public/secret key pair.

Find more information on creating Client Credentials in the Timescale docs.

Project ID

The project ID can be found from the Services dashboard. In the upper right-hand side of the page, click on the three vertical dots to view the project ID.

Create a main.tf configuration file with the following content.

terraform {
  required_providers {
    timescale = {
      source  = "timescale/timescale"
      version = "x.y.z"
    }
  }
}

provider "timescale" {
  project_id = var.ts_project_id
  access_key = var.ts_access_key
  secret_key = var.ts_secret_key
}

variable "ts_project_id" {
  type = string
}

variable "ts_access_key" {
  type = string
}

variable "ts_secret_key" {
  type = string
}

resource "timescale_service" "test" {
  # name       = ""
  # milli_cpu  = 500
  # memory_gb  = 2
  # region_code = "us-east-1"
}

Supported Service Configurations

Compute

• 500m CPU / 2 GB Memory
• 1000m CPU / 4 GB Memory
• 2000m CPU / 8 GB Memory
• 4000m CPU / 16 GB Memory
• 8000m CPU / 32 GB Memory
• 16000m CPU / 64 GB Memory
• 32000m CPU / 128 GB Memory

Storage

Since June 2023, you no longer need to allocate a fixed storage volume or worry about managing your disk size, and you'll be billed only for the storage you actually use. See more info in our blogpost

Regions

Please reference the docs for a list of currently supported regions.

Supported Operations

✅ Create service
✅ Rename service
✅ Resize service
✅ Delete service
✅ Import service
✅ Enable High Availability replicas
✅ Enable read replicas

Billing

Services are currently billed for hourly usage. If a service is running for less than an hour, it will still be charged for the full hour of usage.

Local Provider Usage and Development

Requirements

• Go >= v1.20

Building The Provider

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

go install .

Generating the provider documentation

go generate

Local provider development override

To use the locally built provider, create a ~/.terraformrc file with the following content

provider_installation {

dev_overrides {
   "registry.terraform.io/providers/timescale" = "<PATH>"
}

direct {}
}

Change the <Path> variable to be the location of your GOBIN.

Developing the Provider

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.

make testacc