Skip to content

Commit a46c106

Browse files
authored
Add PlanetScale configuration details to keynote README & DEVELOP (#4474)
# Description of Changes - **keynote-2 docs:** Document PlanetScale benchmark configuration in DEVELOP.md (env vars `PLANETSCALE_PG_URL`, `PLANETSCALE_RPC_URL`, `SKIP_PLANETSCALE_PG`; short “create DB and set env” section; note that we benchmarked using PS-2560, 32 vCPUs, 256 GB RAM). - **README:** Add PlanetScale to cloud tier list (PS-2560, single node, us-central1). Add region (us-central1) to Hardware Configuration for Server Machine Variant B and Client Machine. No code or config changes; documentation only. # API and ABI breaking changes None. # Expected complexity level and risk **Complexity: 1.** Doc-only updates to `templates/keynote-2/README.md` and `templates/keynote-2/DEVELOP.md`. No behavioral or API impact. # Testing - [ ] Skim README and DEVELOP.md for accuracy and formatting.
1 parent d87e494 commit a46c106

2 files changed

Lines changed: 15 additions & 1 deletion

File tree

templates/keynote-2/DEVELOP.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ Copy `.env.example` to `.env` and adjust.
102102
- `CLEAR_CONVEX_ON_PREP` – Convex prep flag (clears data when enabled)
103103
- `CONVEX_USE_SHARDED_COUNTER` – flag for using the sharded-counter implementation
104104

105+
**PlanetScale:**
106+
107+
- `PLANETSCALE_PG_URL` – Postgres connection string
108+
- `PLANETSCALE_RPC_URL` – PlanetScale RPC server URL (default: `http://127.0.0.1:4104`)
109+
- `SKIP_PLANETSCALE_PG``1` = skip PlanetScale in prep
110+
105111
**Bun / RPC helpers:**
106112

107113
- `BUN_URL` – Bun HTTP benchmark server URL
@@ -115,6 +121,12 @@ Copy `.env.example` to `.env` and adjust.
115121

116122
---
117123

124+
## PlanetScale configuration
125+
126+
Create a Postgres database on PlanetScale and set `PLANETSCALE_PG_URL` (and `PLANETSCALE_RPC_URL` if the RPC server runs elsewhere) in `.env`. Reported results used PS-2560 (32 vCPUs, 256 GB RAM).
127+
128+
---
129+
118130
## Setup
119131

120132
### Generate bindings (first time after clone)

templates/keynote-2/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ All systems were tested with **out-of-the-box default settings** - no custom tun
4848

4949
For cloud services, we tested paid tiers to give them their best chance:
5050

51-
- **PlanetScale**: PS-256G (32 cores, 256 GB RAM)
51+
- **PlanetScale**: PS-2560 (32 vCPUs, 256 GB RAM), single node, us-central1.
5252
- **Supabase**: Pro tier
5353
- **Convex**: Pro tier
5454

@@ -101,10 +101,12 @@ docker compose run --rm bench --seconds 10 --concurrency 50 --alpha XX --connect
101101

102102
- c4-standard-32-lssd (32 vCPUs, 120 GB Memory) OS: Ubuntu 24.04
103103
- RAID 0 on 5 Local SSDs
104+
- Region: us-central1
104105

105106
**Client Machine:**
106107

107108
- c4-standard-32 (32 vCPUs, 120 GB Memory) OS: Ubuntu 24.04
109+
- Region: us-central1
108110
- Runs on a **separate machine** from the server
109111

110112
**Note:** All services (databases, web servers, benchmark runner) except Convex local dev backend run in the same Docker environment on the server machine.

0 commit comments

Comments
 (0)