Skip to content

docs(database): define Citus validation cluster setup #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KurodaKayn wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

docs(database): define Citus validation cluster setup #372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/plan/database-optimization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Atomic commit guidance:

#### Phase 6: Citus Distributed PostgreSQL Operation

- [ ] Set up a Citus validation cluster when horizontal scaling is actually needed.
- [ ] Set up a Citus validation cluster when horizontal scaling is actually needed, with coordinator/worker topology, tenant colocation DDL, reference-table rehearsal, and rollback/rebuild runbook documented before real tenant migration.
- [ ] Import synthetic or new workspaces for validation.
- [ ] Configure PgBouncer, monitoring, backup, and failure drills for Citus coordinator/workers.
- [ ] Govern worker concurrency by `workspace_id`.
Expand Down Expand Up @@ -523,7 +523,9 @@ Goal: operate Citus as a future PostgreSQL-compatible distributed runtime for ne

Work items:

- Set up a Citus validation cluster when horizontal scaling is actually needed.
- Set up a Citus validation cluster only after horizontal scaling is justified, using a non-production coordinator and at least two worker nodes.
- Apply the reviewed Phase 5 DDL shape in the validation cluster: distribute `workspaces` first, colocate tenant tables by `workspace_id`, rehearse `users` and small global dimensions as reference-table candidates, and keep control-domain tables outside the distributed group until a routing boundary requires otherwise.
- Document the validation cluster bootstrap, rollback, rebuild, backup-restore, and teardown runbooks before importing any real tenant data.
- Import synthetic or new workspaces for validation, checking colocated joins, publishing-state transitions, collaborative editing, and dashboard read models.
- Configure PgBouncer, backups, monitoring, capacity thresholds, and failure drills separately for Citus coordinator and worker nodes.
- Apply Asynq worker concurrency limits by `workspace_id` and Citus cluster capacity, so single-tenant tasks do not overwhelm workers or the database.
Expand Down
Loading