feat(telemetry): add telemetry.enabled toggle with GHCR fallback and engine opt-out - #53
feat(telemetry): add telemetry.enabled toggle with GHCR fallback and engine opt-out#53dig-whois wants to merge 4 commits into
Conversation
|
Current version of PR was reviewed by /review-bugbot on Jul 28, 13:23 GMT+2. It flagged 0 findings. Bugbot on commit |
There was a problem hiding this comment.
Stale comment
Risk: medium. Left a non-blocking comment — Cursor Bugbot completed as skipped, so the required automated-review signal is incomplete and this cannot be auto-approved. Assigned gm42 and fstr for human review of the telemetry toggle and image-fallback behavior.
Sent by Cursor Approval Agent: Infra Reviewer
Mintlify docs previewDocs were aggregated into the Firebolt documentation site.
Mintlify may take a few minutes to finish building. This comment updates on each sync while the source PR is open. |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit ba298c1. Configure here.
…engine opt-out Add a top-level `telemetry.enabled` value (default true). Setting it to false stamps DO_NOT_TRACK=1 on every engine container — disabling the engine's once-daily anonymous usage event — and, when engineSpec.image.repository is still the default Scarf gateway, switches engine pulls to ghcr.io/firebolt-db/engine. A user-supplied repository and a user-supplied DO_NOT_TRACK in engineSpec.extraEnv are preserved. Mirrors the firebolt-operator chart's single-toggle opt-out. Render assertions for both toggle states are part of chart validation.
d89571f to
2e10bc9
Compare



Summary
telemetry.enabledvalue (defaulttrue), mirroring the firebolt-operator chart's single-toggle opt-out.false, the chart stampsDO_NOT_TRACK=1on every engine container — disabling the engine's once-daily anonymous usage event (firebolt-analytics/packdb#24471) — and, whenengineSpec.image.repositoryis still the default Scarf gateway, switches engine pulls toghcr.io/firebolt-db/engine. A user-supplied repository is used verbatim, and aDO_NOT_TRACKentry inengineSpec.extraEnvstill wins (it renders after the chart-managed env).DO_NOT_TRACK), opt-out (GHCR +DO_NOT_TRACK=1), and opt-out with a custom repository (repository preserved).Test plan
./helm/scripts/validate-chart.shgreen, including the new toggle assertionsNote
Low Risk
Chart-only behavior behind an opt-in default; changes engine env and image URL only when users set
telemetry.enabled=false, with validation guarding regressions.Overview
Introduces a top-level
telemetry.enabledchart value (defaulttrue) so installs can opt out of anonymous engine usage telemetry in one place.When
telemetry.enabled: false, the chart setsDO_NOT_TRACK=1on engine containers (beforeengineSpec.extraEnv, so a user override still wins) and routes default engine image pulls from the Scarf gateway toghcr.io/firebolt-db/enginevia a newfbinstance.engineImagehelper—only when the repository is still the default; custom mirrors are unchanged.values.schema.json,helm-docs, README, quickstart, and image-overrides docs describe the toggle and related opt-out paths.validate-chart.shgains Step 4: default render (Scarf image, noDO_NOT_TRACK), full opt-out (GHCR +DO_NOT_TRACK), and opt-out with a custom repository preserved..legitignoreadds an entry for the validation dummy PostgreSQL password.Reviewed by Cursor Bugbot for commit 2e10bc9. Bugbot is set up for automated code reviews on this repo. Configure here.