> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Timescale Cloud Service

> Provision a Timescale Cloud (TimescaleDB/Postgres) service with configurable CPU, memory, and HA replicas, via the Timescale Terraform provider

Qovery creates it in your account with a third-party provider, using credentials you enter in the form, as a [Blueprint](https://www.qovery.com/docs/configuration/blueprints.md) service in one of your environments.

| | |
| - | - |
| Catalog name | `timescale-cloud-service` |
| Category | Databases & Caches |
| Provider | EXTERNAL |
| Engine | terraform |
| Major versions (latest release) | `default` (1.0.7) |
| Source | [EXTERNAL/timescale-cloud/default](https://github.com/Qovery/service-catalog/tree/EXTERNAL/timescale-cloud/default/1.0.7/EXTERNAL/timescale-cloud/default) |

> [!TIP]
>
> **New to this?** You don't need to know Terraform or Kubernetes. Qovery sets up Timescale Cloud Service in your account with the provider: you fill in a form, or paste the prompt below into your coding agent. The values it publishes, listed under Outputs, reach your other services as environment variables. Qovery tells you when a newer version of the Blueprint is available. Check the requirements in the Reference section before you start, and try it first in a development environment.

## Create it

> [tab] Console
>
> 1. Open the environment, then **New service** › **Blueprint**.
> 2. Find **Timescale Cloud Service** in the catalog and pick the major version.
> 3. Fill in the variables. Required ones are marked; the others use their defaults.
> 4. Create the service, and deploy it now or later.

> [tab] CLI and API
>
> List the catalog to get the latest tag, then create the service from it. `qovery api` signs the requests with your CLI session.
>
> ```bash theme={null}
> ORG_ID="REPLACE_WITH_ORGANIZATION_ID"
> ENV_ID="REPLACE_WITH_ENVIRONMENT_ID"
>
> qovery api "organization/$ORG_ID/blueprint/catalog" | jq '.. | objects | select(.name? == "timescale-cloud-service")'
>
> cat > blueprint.json <<'EOF'
> {
>   "name": "timescale-cloud-service",
>   "tag": "EXTERNAL/timescale-cloud/default/1.0.7",
>   "icon": "app://qovery-console/timescaledb",
>   "variables": [
>     {
>       "name": "timescale_project_id",
>       "value": "REPLACE_WITH_TIMESCALE_PROJECT_ID"
>     },
>     {
>       "name": "timescale_access_key",
>       "value": "REPLACE_WITH_TIMESCALE_ACCESS_KEY",
>       "is_secret": true
>     },
>     {
>       "name": "timescale_secret_key",
>       "value": "REPLACE_WITH_TIMESCALE_SECRET_KEY",
>       "is_secret": true
>     },
>     {
>       "name": "service_name",
>       "value": "REPLACE_WITH_SERVICE_NAME"
>     }
>   ],
>   "spec_overrides": {
>     "engine_version": "1.9.7"
>   }
> }
> EOF
> BLUEPRINT_ID=$(qovery api "environment/$ENV_ID/blueprint" --method POST --input - < blueprint.json | jq -r .id)
> rm blueprint.json   # it can hold secret values
> qovery api "blueprint/$BLUEPRINT_ID/deploy" --method POST
> qovery api "blueprint/$BLUEPRINT_ID"   # status of the latest deployment
> ```
>
> Replace each `REPLACE_WITH_` value. Add optional variables to `variables` the same way.

> [tab] Coding agent
>
> Paste this into Claude Code, Cursor, Codex or another coding agent with the [Qovery agent skills](https://www.qovery.com/docs/getting-started/quickstart/agent-skills.md) installed (`curl -fsSL https://skill.qovery.com/install.sh | bash`).
>
> ```text Prompt wrap theme={null}
> Add the Qovery Blueprint Timescale Cloud Service (timescale-cloud-service) to one of my Qovery environments and deploy it. Ask me for timescale_project_id, timescale_access_key, timescale_secret_key and service_name.
> Ask me before deploying to a production environment.
> Docs: https://www.qovery.com/docs/configuration/blueprints/timescale-cloud-service.md
> ```

You don't add any file to your repository. Qovery creates the Blueprint from the Console or the API.

## Variables and outputs

Generated from `qbm.yml` at `EXTERNAL/timescale-cloud/default/1.0.7`, the manifest the Console form is built from.

> [accordion] All 8 variables
>
> | Name | Type | Required | Default | Secret | Description |
> | - | - | - | - | - | - |
> | `timescale_project_id` | string | Yes | | | Timescale Cloud project ID |
> | `timescale_access_key` | string | Yes | | Yes | Timescale Cloud client credentials - access key |
> | `timescale_secret_key` | string | Yes | | Yes | Timescale Cloud client credentials - secret key |
> | `service_name` | string | Yes | | | 1–128 chars |
> | `region_code` | string | | `us-east-1` | | AWS-style code, e.g. us-east-1, eu-west-1 |
> | `milli_cpu` | number | | `500` | | CPU in milli-CPU; must pair with memory\_gb |
> | `memory_gb` | number | | `2` | | Memory in GB; must pair with milli\_cpu (500m/2GB, 1000m/4GB, …) |
> | `ha_replicas` | number | | `0` | | High-availability replicas, 0–2 |

Outputs become environment variables that other services in the environment can use. By default Qovery also creates an alias for each output, prefixed with the Blueprint's name; see [Aliases Qovery creates for outputs](https://www.qovery.com/docs/configuration/environment-variables.md#aliases-qovery-creates-for-outputs) for the naming rules and the cases where no alias is created.

> [accordion] All 6 outputs
>
> | Name | Secret | Description |
> | - | - | - |
> | `service_id` | | Timescale service ID |
> | `hostname` | | Service hostname |
> | `port` | | Service port |
> | `username` | | Master database username |
> | `password` | Yes | Master database password |
> | `connection_uri` | Yes | PostgreSQL URI with credentials (database tsdb, TLS required) |

> [!WARNING]
>
> Secret variables and outputs are encrypted and masked in Qovery, but Terraform can also keep their values, and values derived from them, in its state. With the Qovery-managed state backend (the default), Qovery stores the state. If you use your own backend, protect it and keep state files out of version control.

## Reference

From the Blueprint's [README](https://github.com/Qovery/service-catalog/blob/EXTERNAL/timescale-cloud/default/1.0.7/EXTERNAL/timescale-cloud/default/README.md).

Provisions a [Timescale Cloud](https://www.timescale.com/cloud) service (`timescale_service`) — managed TimescaleDB/PostgreSQL — via the official `timescale/timescale` provider (`~> 2.0`).

> **Timescale Cloud only** (managed SaaS), not self-hosted TimescaleDB.

### Credentials

Timescale Cloud **client credentials**: `timescale_project_id` + a `timescale_access_key` / `timescale_secret_key` pair (both sensitive), supplied as variables (`credentials.default: env`).

### Variables

#### Required

| Name | Type | Sensitive | Description |
| - | - | - | - |
| `timescale_project_id` | string | | Timescale Cloud project ID |
| `timescale_access_key` | string | yes | Client credentials — access key |
| `timescale_secret_key` | string | yes | Client credentials — secret key |
| `service_name` | string | | Timescale service name (1-128 chars) |

#### Service shape

| Name | Type | Default | Description |
| - | - | - | - |
| `region_code` | string | `us-east-1` | Region for the service (AWS-style code, e.g. us-east-1, eu-west-1) |
| `milli_cpu` | number | `500` | CPU allocation in milli-CPU. Must pair with `memory_gb` per Timescale's allowed sizes. |
| `memory_gb` | number | `2` | Memory in GB. Timescale pairs this with `milli_cpu` (500m/2GB, 1000m/4GB, 2000m/8GB, ...). |
| `ha_replicas` | number | `0` | High-availability replicas (0-2) |

Timescale requires matching CPU/memory pairs — `500m ↔ 2GB`, `1000m ↔ 4GB`, `2000m ↔ 8GB`, and so on. Mismatched pairs are rejected at apply time.

### Outputs

| Name | Sensitive | Description |
| - | - | - |
| `service_id` | | Timescale service ID |
| `hostname` | | Service hostname |
| `port` | | Service port |
| `username` | | Master database username |
| `password` | yes | Master database password |
| `connection_uri` | yes | Ready-to-use PostgreSQL URI (creds embedded, db `tsdb`, TLS) |

### Notes

* Provisioning a Timescale Cloud service is billable.
* The master `password` is only returned by the API at creation time; it is surfaced as a sensitive output.


## Related topics

- [Blueprints](https://www.qovery.com/docs/configuration/blueprints.md)
- [Redpanda Cloud](https://www.qovery.com/docs/configuration/blueprints/redpanda-kafka.md)
- [Temporal Cloud Namespace](https://www.qovery.com/docs/configuration/blueprints/temporal-cloud-namespace.md)
- [CloudFormation](https://www.qovery.com/docs/configuration/integrations/iac/cloudformation.md)
- [AWS CloudFront](https://www.qovery.com/docs/configuration/blueprints/aws-cloudfront.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.