PostgreSQL
1. Overview
The PostgreSQL add-on deploys a dedicated instance of the PostgreSQL relational database inside an environment, with ACID support, JSON, and automatic backups.
Use it when an application, Flow, or another add-on needs its own relational database, isolated from the others.
Catalog tags: Database, SQL.
2. Prerequisites
- A squad and an environment already selected on the Add-ons screen.
3. Deploy Step-by-Step
The PostgreSQL deploy wizard has 4 steps:
Step 1 — General
| Field | Required | Description |
|---|---|---|
| Add-on Name | Yes | Name of the add-on within the environment. Lowercase letters, numbers, and hyphens only (3 to 63 characters). Example: my-postgres. |
Step 2 — Admin User
Defines the instance's superuser credentials, used by the admin console, backups, and the copilot.
| Field | Required | Description |
|---|---|---|
| Admin Username | Yes | PostgreSQL superuser. Default: postgres. |
| Password | Yes | Superuser password. |
| Database Name | Yes | Name of the database created on the instance. Default: postgres. |
Step 3 — Backup
Configures the instance's automatic backups. Daily backups are uploaded to Google Cloud Storage, and the oldest ones are automatically purged once the retention limit is exceeded.
| Field | Required | Description |
|---|---|---|
| Enable automatic backups | No | Turns automatic backups on/off. On by default. |
| Keep last N backups | If backups are on | Number of most recent backups kept before purging the oldest ones. Default: 10. |
| Cron schedule (UTC) | If backups are on | Cron expression (in UTC) that defines the backup frequency. Default: 0 2 * * * (every day at 02:00 UTC). |
Step 4 — Database Resources (PostgreSQL)
Defines the resources allocated to the instance.
| Field | Default | Maximum |
|---|---|---|
| Memory | 512Mi | 2Gi |
| CPU | 500m | 2000m |
| Disk Size | 5Gi | 20Gi |
Clicking Deploy Add-on starts the deployment. The add-on then appears on the environment's My Add-ons tab.
4. After Deployment
TODO: describe how to obtain the instance's connection string/host after deployment, and how to restore a backup from Google Cloud Storage.
5. FAQ
Can automatic backups be turned off after deployment?
TODO: confirm whether Enable automatic backups can be changed after deployment.
Where are backups stored and for how long? TODO: confirm storage bucket/location and retention policy beyond "Keep last N backups".