docs: Self hosting CloudSQL setup by adityathebe · Pull Request #507 · flanksource/docs

adityathebe · 2026-05-06T06:52:50Z

resovles: #506

Summary by CodeRabbit

Documentation
- Added guidance for using Google Cloud SQL with PostgreSQL in self-hosted installations, including role/grant setup.
- Introduced documentation for a new GitHub scraper configuration block (repository, auth, connection, security and filtering options).
- Normalized formatting in table column docs to improve readability for config-item and gauge column references.

vercel · 2026-05-06T06:52:55Z

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

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview	May 6, 2026 10:01am

netlify · 2026-05-06T06:52:56Z

✅ Deploy Preview for canarychecker canceled.

Name	Link
🔨 Latest commit	`dde18ac`
🔍 Latest deploy log	https://app.netlify.com/projects/canarychecker/deploys/69fb10892c5ea20008dcd81b

coderabbitai · 2026-05-06T06:53:04Z

Warning

Rate limit exceeded

@adityathebe has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 4 minutes and 21 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f161c1fa-0331-44ce-ae53-99bb78085fa1

📥 Commits

Reviewing files that changed from the base of the PR and between f2c24a8 and dde18ac.

📒 Files selected for processing (1)

mission-control/docs/installation/self-hosted/database.md

Walkthrough

Documentation updates: added a Google Cloud SQL subsection to self-hosted database docs, introduced a GitHub scraper configuration schema example, and normalized indentation in two table column docs. All changes are documentation-only; no code or API surface changes.

Changes

Google Cloud SQL Installation Documentation

Layer / File(s)	Summary
Documentation `mission-control/docs/installation/self-hosted/database.md`	Added a "Google Cloud SQL" subsection under "Using an External Database" with SQL grant statements to grant `cloudsqlsuperuser` and `CREATEROLE`, and a placeholder note to replace the username used in Mission Control DB secret.

GitHub Scraper Configuration Docs

Layer / File(s)	Summary
Schema / Example `mission-control/docs/guide/config-db/scrapers/github.md`	Added a top-level GitHub configuration block example and schema fields: `repositories`, `personalAccessToken`, `connection`, `security`, `openssf`, and `securityFilters`.
Subsections `mission-control/docs/guide/config-db/scrapers/github.md`	Added `GitHubRepository` subsection (`owner`, `repo`) and `SecurityFilters` subsection (`severity`, `state`, `maxAge`).
Formatting `mission-control/docs/guide/config-db/scrapers/github.md`	Adjusted code fence markers around the `github.yaml` example.

Table Column Docs — Indentation Normalization

Layer / File(s)	Summary
Formatting `mission-control/docs/guide/views/table/columns/config-item.md`	Normalized indentation of the first `ColumnDef` rows array item (removed two-space prefix).
Formatting `mission-control/docs/guide/views/table/columns/gauge.md`	Removed leading indentation from six `ColumnDef` rows entries; content unchanged.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: Self hosting CloudSQL setup' accurately describes the main change - adding Google Cloud SQL documentation for self-hosted deployments, which is evident in the database.md additions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/cloudsql

✨ Simplify code

Create PR with simplified code
Commit simplified code in branch docs/cloudsql

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@mission-control/docs/installation/self-hosted/database.md`:
- Around line 71-76: Remove the stray HTML line break and ensure the fenced SQL
block is followed by a blank line: delete the `<br />` tag shown after the
```sql block and insert a single blank line between the closing ``` and the
explanatory sentence "Replace `your_username` with the user configured in the
Mission Control database secret." so the GRANT cloudsqlsuperuser / ALTER ROLE
your_username CREATEROLE code block is properly surrounded by blank lines per
MD031.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4c23a0ab-04b1-4a4b-9464-9e571229bd5d

📥 Commits

Reviewing files that changed from the base of the PR and between 7f37957 and 9f48504.

📒 Files selected for processing (1)

mission-control/docs/installation/self-hosted/database.md

coderabbitai

♻️ Duplicate comments (1)

mission-control/docs/installation/self-hosted/database.md (1)
76-77: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove the stray HTML line break.

Line 76 uses <br />, which is unnecessary here and hurts markdown readability. Keep a plain blank line before the note on Line 77.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@mission-control/docs/installation/self-hosted/database.md` around lines 76 -
77, Remove the stray HTML tag "<br />" that appears before the note "Replace
`your_username` with the user configured in the Mission Control database
secret." — leave a plain blank line instead so the markdown reads correctly;
locate the "<br />" token and delete it, ensuring the surrounding markdown
paragraph and the inline code snippet `your_username` remain unchanged.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Duplicate comments:
In `@mission-control/docs/installation/self-hosted/database.md`:
- Around line 76-77: Remove the stray HTML tag "<br />" that appears before the
note "Replace `your_username` with the user configured in the Mission Control
database secret." — leave a plain blank line instead so the markdown reads
correctly; locate the "<br />" token and delete it, ensuring the surrounding
markdown paragraph and the inline code snippet `your_username` remain unchanged.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: de37695d-0105-4efa-9774-48216e8a318f

📥 Commits

Reviewing files that changed from the base of the PR and between 9f48504 and f2c24a8.

📒 Files selected for processing (4)

mission-control/docs/guide/config-db/scrapers/github.md
mission-control/docs/guide/views/table/columns/config-item.md
mission-control/docs/guide/views/table/columns/gauge.md
mission-control/docs/installation/self-hosted/database.md

✅ Files skipped from review due to trivial changes (1)

mission-control/docs/guide/views/table/columns/config-item.md

adityathebe requested a review from moshloop May 6, 2026 06:52

vercel Bot had a problem deploying to Preview May 6, 2026 06:53 Failure

coderabbitai Bot reviewed May 6, 2026

View reviewed changes

Comment thread mission-control/docs/installation/self-hosted/database.md

vercel Bot had a problem deploying to Preview May 6, 2026 09:03 Failure

coderabbitai Bot reviewed May 6, 2026

View reviewed changes

adityathebe force-pushed the docs/cloudsql branch from f2c24a8 to 7f07fee Compare May 6, 2026 09:13

vercel Bot had a problem deploying to Preview May 6, 2026 09:14 Failure

adityathebe added 2 commits May 6, 2026 15:42

docs: Self hosting CloudSQL setup

877845c

fix: lint error

dde18ac

adityathebe force-pushed the docs/cloudsql branch from 7f07fee to dde18ac Compare May 6, 2026 09:57

vercel Bot deployed to Preview May 6, 2026 10:01 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Self hosting CloudSQL setup#507

docs: Self hosting CloudSQL setup#507
adityathebe wants to merge 2 commits intomainfrom
docs/cloudsql

adityathebe commented May 6, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented May 6, 2026 •

edited

Loading

Uh oh!

netlify Bot commented May 6, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 6, 2026 •

edited

Loading

Rate limit exceeded

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

adityathebe commented May 6, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for canarychecker canceled.

Uh oh!

coderabbitai Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

adityathebe commented May 6, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented May 6, 2026 •

edited

Loading

netlify Bot commented May 6, 2026 •

edited

Loading

coderabbitai Bot commented May 6, 2026 •

edited

Loading