Uh oh!
There was an error while loading. Please reload this page.
docs: finish the MySQL/egress overclaim fix on main (backend#1186) - #72
Conversation
PR #68 corrected the "air-gapped" FAQ and the security.mdx MySQL claim, but only touched security.mdx + faqs.mdx. Three pages still carried the same factual error on main: - overview.mdx: "a NetworkPolicy that blocks data egress from training pods" — false by default (networkPolicy.training.allowExternalHttps defaults true), and it contradicted the already-merged security.mdx ("Direct outbound HTTPS is still allowed by default today"). - configuration.mdx + eks-client-deployment-guide.mdx: NetworkPolicy "blocking pod-to-pod, MySQL, and Kubernetes API access" — the chart's network-policy-training.yaml (rule 3) explicitly PERMITS TCP/3306 to the in-cluster mysql-client pod; training reads its dataset from it and CrashLoopBackOffs without it. Reworded to mirror the accurate security.mdx description: MySQL and the results proxy stay reachable, arbitrary pod-to-pod + K8s API are blocked, direct outbound HTTPS is on by default with an optional stricter lockdown. Verified against client/client/templates/network-policy-training.yaml and values.yaml (allowExternalHttps: true). Refs tracebloc/backend#1186. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
LukasWodka
commented
Jul 30, 2026
bugbot run |
LukasWodka
commented
Jul 30, 2026
👋 Heads-up — Code review queue is at 31 / 30 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 08f89ef. Configure here.
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
LukasWodka
commented
Jul 31, 2026
Sweep result: no findings — content re-verified against the chart, not just re-readBugbot: 0 issues. All checks green ( Because a docs claim is only as good as the code it describes, I re-derived every factual assertion in this PR from the current
So "blocks data egress" / "blocking … MySQL" were genuinely false, and the replacement wording is accurate. No overclaim introduced. Terminology check — clean. Swept the whole branch, not just the diff:
CNI dependency is caveated on both rewritten pages — worth confirming, since "restricts egress" is only true if the CNI enforces: Base branch is Confirmed: the |
develop line | Current text |
|---|---|
environment-setup/security.mdx:21 | "Training pods are denied data egress — they can't reach MySQL, other pods, or the Kubernetes API." — false on all three counts |
tools-help/faqs.mdx:31 | "### Do you support air-gapped clusters?" answered "Yes" — the pinned-terminology violation |
configuration.mdx:291 · eks-client-deployment-guide.mdx:746 · overview.mdx:48 | the three this PR fixes, unfixed there |
So the backmerge recommendation stands: without a main → develop reconcile, the next develop → main release PR silently reverts all five. That's a decision for @LukasWodka, not something to fix in this PR. I did not touch develop.
aptracebloc
left a comment
There was a problem hiding this comment.
Approving — accurate correction of the NetworkPolicy egress overclaim (in-cluster MySQL and the results proxy stay reachable; outbound HTTPS allowed by default with an optional egress-gateway lockdown). Consistent wording across all three files; CI green.
What this fixes
Completes the factual-correction half of
tracebloc/backend#1186(RFC-0003 §9 messaging alignment). PR #68 corrected the "air-gapped" FAQ and thesecurity.mdxMySQL claim, but it only editedsecurity.mdx+faqs.mdx. Three other pages onmainstill carried the same overclaim — this PR finishes the sweep so the live docs are internally consistent.Ground truth verified against the chart itself —
tracebloc/client/client/templates/network-policy-training.yamlandvalues.yaml:mysql-clientpod and CrashLoopBackOffs without it — so any claim that the NetworkPolicy blocks MySQL access is false.requests-proxy(8888) is also always permitted (rule 4).networkPolicy.training.allowExternalHttps: true,values.yaml:188) — so "blocks data egress" is false by default. The stricter gateway-routed lockdown ships with the chart but is off until an operator enables it.Reworded to mirror the accurate description already merged in
security.mdx:21.Changes (file:line → before / after)
1.
environment-setup/overview.mdx:48security.mdx("Direct outbound HTTPS is still allowed by default today"). Kept tight — this is the high-level Overview page.2.
environment-setup/configuration.mdx:2913.
environment-setup/eks-client-deployment-guide.mdx:746No headings/anchors changed; no link targets touched; MDX unchanged structurally.
developis stale and will regressmainon the next promotiondevelopnever received PR #68 (it's behindmainby 4 commits) and never had these three lines fixed. Sodevelopcurrently carries all five overclaims:develop:environment-setup/security.mdx:21main)develop:tools-help/faqs.mdx:31develop:environment-setup/configuration.mdx:291develop:environment-setup/eks-client-deployment-guide.mdx:746develop:environment-setup/overview.mdx:48Recommendation: after this merges, do a
main → developbackmerge to reconcile. Otherwise a futuredevelop → mainrelease PR (like #60 / #57) can re-introduce the corrected overclaims onto the live site. This is a pre-existing drift from #68 targetingmaindirectly — not created here, but worth closing out.Deferred (intentionally NOT in this PR — positioning/voice, per #68)
Same items #68 reserved for you, still open:
TERMINOLOGY.mdas the quotable source of truth.workspace→secure environmentrename acrossoverview.mdx/security.mdx(terminology drift, not a factual error).tracebloc-websitemarketing copy (different repo).Refs
tracebloc/backend#1186.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only factual corrections with no runtime or configuration behavior changes.
Overview
Finishes the RFC-0003 / backend#1186 factual sweep on
main: three environment-setup pages still claimed training NetworkPolicy blocks MySQL and implied all data egress is blocked. They now match the chart and the wording already fixed insecurity.mdx.overview.mdx— Replaces "blocks data egress from training pods" with "restricts training-pod egress" so the overview no longer implies default egress is fully blocked.configuration.mdxandeks-client-deployment-guide.mdx— Replaces the old "DNS + external HTTPS only … blocking pod-to-pod, MySQL, and Kubernetes API" line with an accurate description: ingress denied; arbitrary pod-to-pod and API egress blocked; in-cluster MySQL (training data) and the results proxy stay allowed; direct outbound HTTPS is on by default, with optional stricter routing via an in-cluster egress gateway.No code, anchors, or structural MDX changes—copy only.
Reviewed by Cursor Bugbot for commit 08f89ef. Bugbot is set up for automated code reviews on this repo. Configure here.