https://github.com/cyril-sabourault/postgrest-cloud-run
Demo project using Terraform to deploy PostgREST on Cloud Run using Cloud SQL
https://github.com/cyril-sabourault/postgrest-cloud-run
cloud-run cloud-sql gcp terraform
Last synced: 4 months ago
JSON representation
Demo project using Terraform to deploy PostgREST on Cloud Run using Cloud SQL
- Host: GitHub
- URL: https://github.com/cyril-sabourault/postgrest-cloud-run
- Owner: cyril-sabourault
- Created: 2021-12-07T22:55:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-11T16:50:06.000Z (about 3 years ago)
- Last Synced: 2024-08-13T07:03:07.767Z (8 months ago)
- Topics: cloud-run, cloud-sql, gcp, terraform
- Language: HCL
- Homepage:
- Size: 127 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - cyril-sabourault/postgrest-cloud-run - Demo project using Terraform to deploy PostgREST on Cloud Run using Cloud SQL (HCL)
README
# Expose your Postgres database on Cloud SQL easily with Cloud Run
The [PostgREST][postgrest-doc] project provides a CRUD API on top of your postgres database.
What better way to explore your data than with an OpenAPI running on Cloud Run?
## Overview
Thanks to Cloud Run easy integration with Cloud SQL and Secret Manager it's very easy to connect all we need!
> Your data in Cloud SQL
> ↕️
> VPC Connector
> ↕️
> SQL Connection
> ↕️
> Cloud Run service
## Content of this repo 🕵🏻
This repo serves as a demo, it will:
- Create a Cloud SQL instance with Postgres in a private VPC.
- Set the `postgres` password and store it in Secret Manager
- Initialize a Cloud Run Service, with a VPC Connector, a SQL Connection to the SQL instance, and mounting the password from Secret
- Finally, output the Service Endpoint and optional gcloud commands to populate the database
> **/!\\ Permission**: the resulting Cloud Run service is available publicly for ease of access
Exemple of deployed interface ⤵️
![swagger preview][docs-swagger-preview]
Exemple generated openapi spec:
[openapi.json][openapi-json]
```
.
├── cloud_run
│ ├── cloud_run.tf
│ ├── outputs.tf
│ └── variables.tf
│
├── cloud_sql
│ ├── outputs.tf
│ ├── postgres.tf
│ └── variables.tf
│
├── secret_manager
│ ├── outputs.tf
│ ├── secret_manager.tf
│ └── variables.tf
│
└── main.tf
├── terraform.tfvars
└── [backend.tf]
```
## Deploy 🚀
Authenticate first using gcloud's ADC
```sh
gcloud auth application-default login
```
Fill in your own GCP project id in the `terraform.tfvars` file.
[Optionnaly, uncomment the `backend.tf` file and fill in your GCS bucket name if you want a remote state.]
Deploy!
```sh
tf init
tf plan -var-files=terraform.tfvars -out tfplan
# (the tf apply will start immediately,
#+ you better review the tf plan output first)
tf apply tfplan
```
Go grab a coffee while Terraform is doing its magic ☕️ ✨
Come back to Terraform outputting gcloud commands to populate the db and the service URL to inspect your data! 🔍 👀
## Cleanup 🧹
Set the _`deletion_protection`_ field in `cloud_sql/postgres.tf` to _`false`_ on the SQL Database instance:
resource "google_sql_database_instance" "postgrest" {
(...)
deletion_protection = true -> false
(...)
}
Apply the change
```sh
tf apply -var-file=terraform.tfvars \
-target module.postgrest_database.google_sql_database_instance.postgrest
```
Confirm you want to delete all resources
```sh
tf destroy
```
[postgrest-doc]: https://postgrest.org
[docs-swagger-preview]: docs/swagger-preview.png
[openapi-json]: docs/openapi.json