Skip to content

docs(experimentation): document PostgreSQL warehouses - #8873

Merged
Zaimwa9 merged 12 commits into
mainfrom
docs/postgres-warehouse
Nov 6, 2026
Merged

Zaimwa9 merged 12 commits into
mainfrom
docs/postgres-warehouse

Conversation

@Zaimwa9

@Zaimwa9 Zaimwa9 commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Documents PostgreSQL warehouses (#8857, #8863, #8864, #8872).

  • New Connect PostgreSQL (bring your own) and Self-Hosting and Open Source (deployment options, SDK events URL, limits) pages.
  • Connect a Warehouse covers the self-hosted Flagsmith database next to the Cloud Flagsmith warehouse.
  • Setup copy now asks for a superuser or a role with CREATEROLE and CREATE on the database, and the setup SQL password placeholder is YOUR_PASSWORD.
  • A parity test keeps the docs' setup SQL in line with the dashboard's.

How did you test this code?

Prettier, and the setup SQL unit and docs parity tests.

@vercel

vercel Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Nov 6, 2026 9:55am UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Nov 6, 2026 9:55am UTC
flagsmith-frontend-staging Ignored Ignored Preview Nov 6, 2026 9:55am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The changes add self-hosting guidance for experimentation, including event routing and rejection limits. They document PostgreSQL as an experiment-event warehouse and provide setup, permissions, connection, and troubleshooting instructions. Existing warehouse guidance now covers PostgreSQL and limits first-event verification instructions to Flagsmith Cloud where specified. ClickHouse and PostgreSQL onboarding SQL use the <YOUR_PASSWORD> placeholder. A test checks that the documented PostgreSQL SQL matches the generated onboarding SQL.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: Low · up to 49dda

PostgreSQL setup can fail with restricted database permissions or an existing schema. The SQL parity test can also miss line-sensitive changes; these bounded issues warrant follow-up.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: bf1c7b83-9f32-486e-91bd-1b15a040a206
Commits

Reviewing files that changed from the base of the PR and between 6cc79f8 and 49ddaed.

Files selected for processing: 3

  • docs/docs/experimentation/connect-a-warehouse.md
  • docs/docs/experimentation/connect-postgresql.md
  • docs/docs/experimentation/self-hosting.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@github-actions github-actions Bot added front-end Issue related to the React Front End Dashboard docs Documentation updates and removed docs Documentation updates labels Nov 4, 2026
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 4, 2026
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 4, 2026
@github-actions github-actions Bot removed the docs Documentation updates label Nov 4, 2026
@github-actions github-actions Bot added the docs Documentation updates label Nov 4, 2026
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 5, 2026
@Zaimwa9
Zaimwa9 marked this pull request as ready for review November 5, 2026 11:12
@Zaimwa9
Zaimwa9 requested review from a team as code owners November 5, 2026 11:12
@Zaimwa9
Zaimwa9 requested review from matthewelwell and talissoncosta and removed request for a team November 5, 2026 11:12
@github-actions github-actions Bot removed the docs Documentation updates label Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-e2e:pr-8873 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api-test:pr-8873 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api:pr-8873 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith:pr-8873 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith-private-cloud:pr-8873 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith-frontend:pr-8873 Finished ✅ Results ✅

@github-actions github-actions Bot added the docs Documentation updates label Nov 5, 2026
@Zaimwa9
Zaimwa9 requested review from gagantrivedi and removed request for matthewelwell and talissoncosta November 5, 2026 11:13
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor
✅ private-cloud · depot-ubuntu-latest-arm-16 — run #22905 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  46.2 seconds
commit  49ddaed
info  🔄 Run: #22905 (attempt 1)

🗂️ Previous results
✅ private-cloud · depot-ubuntu-latest-16 — run #22905 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  51 seconds
commit  49ddaed
info  🔄 Run: #22905 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #22905 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  35.4 seconds
commit  49ddaed
info  🔄 Run: #22905 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #22905 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  30.6 seconds
commit  49ddaed
info  🔄 Run: #22905 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #22891 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  45.7 seconds
commit  6cc79f8
info  🔄 Run: #22891 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #22891 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  34 seconds
commit  6cc79f8
info  🔄 Run: #22891 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #22891 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  36.6 seconds
commit  6cc79f8
info  🔄 Run: #22891 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #22891 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  32 seconds
commit  6cc79f8
info  🔄 Run: #22891 (attempt 1)

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Visual Regression

24 screenshots compared. See report for details.
View full report

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Nitpick comments: 1

frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/postgresSetupSqlDocs.test.ts: 1

5-5: Trivial · Functional Correctness · Quick win

Normalise each line separately in the docs parity test.

normalise replaces every line break with a space. In the docs fence, a -- comment can then run into the next statement. If a future edit moves CREATE USER onto the comment line, the normalised text still matches the dashboard SQL, so the test passes. PostgreSQL does not run the joined CREATE USER, and the following GRANT statements fail because the role does not exist. The current guide is correct, so this affects only future edits to the docs.

Normalise each line separately to keep the line boundaries:

Suggested fix

-const normalise = (sql: string) => sql.replace(/\s+/g, ' ').trim()
+const normalise = (sql: string) =>
+  sql
+    .split('\n')
+    .map((line) => line.replace(/\s+/g, ' ').trim())
+    .filter(Boolean)
+    .join('\n')
Review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: e8cffcbc-124d-455d-98d0-45909dde738b
Commits

Reviewing files that changed from the base of the PR and between af5c88f and 6cc79f8.

Files ignored due to path filters: 4

  • docs/static/img/experimentation/warehouse-flagsmith-database-connected.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-flagsmith-database.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-postgres-connected.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-postgres-form.png is excluded by !**/*.png
Files selected for processing: 13

  • docs/docs/deployment-self-hosting/core-configuration/environment-variables.md
  • docs/docs/deployment-self-hosting/hosting-guides/kubernetes-openshift.md
  • docs/docs/experimentation/connect-a-warehouse.md
  • docs/docs/experimentation/connect-databricks.md
  • docs/docs/experimentation/connect-postgresql.md
  • docs/docs/experimentation/run-an-experiment.mdx
  • docs/docs/experimentation/self-hosting.md
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/WarehouseSetup.tsx
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/clickhouseSetupSql.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/postgresSetupSql.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/postgresSetupSqlDocs.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/clickhouseSetupSql.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/postgresSetupSql.ts

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 6, 2026
@Zaimwa9
Zaimwa9 requested a review from gagantrivedi November 6, 2026 10:30
@Zaimwa9
Zaimwa9 merged commit a130da6 into main Nov 6, 2026
31 checks passed
@Zaimwa9
Zaimwa9 deleted the docs/postgres-warehouse branch November 6, 2026 12:16

This branch was successfully deployed

3 active (2 outdated) deployments
Preview – docs — 49ddaedf Deployed Nov 6, 2026 by vercel[bot]
Preview – flagsmith-frontend-preview — 2e8dbd5b Deployed Nov 4, 2026 by vercel[bot]
Preview – flagsmith-frontend-staging — 2e8dbd5b Deployed Nov 4, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates front-end Issue related to the React Front End Dashboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants