docs: restore Scarf gateway disclosure (FB-1354) - #30
Merged
Conversation
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. |
gm42
previously approved these changes
Jul 14, 2026
Advertise the Firebolt-owned gateway and badges while documenting exactly what download metadata is visible and how users can bypass Scarf.
dig-whois
force-pushed
the
fb-1354-scarf-v2
branch
from
July 20, 2026 07:08
dd5f174 to
df4cd55
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Use the Firebolt-owned gateway for default engine downloads while documenting the direct-GHCR opt-out and keeping Kind test mirrors compatible.
Keep public chart defaults measurable while preventing test and development environments from generating download analytics.
Describe repository selection directly without embedding telemetry rollout rationale in development and CI configuration.
Packdb docs aggregation ready for reviewDocs were merged to Squash-merge the packdb PR into |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
oci.firebolt.io/firebolt-db/engineoci.firebolt.ioin Kind for explicit testing of shipped defaultsOpt out
To bypass Scarf completely, install from
oci://ghcr.io/firebolt-db/helm-charts/firebolt-instanceand setengineSpec.image.repository=ghcr.io/firebolt-db/engine. Any custom engine repository remains supported unchanged.Firebolt-managed compute deployments already set engine repositories to the internal ECR mirror and therefore bypass Scarf.
Test plan
make docsmake lintmake docs-checkoci.firebolt.iovalues-dev.yamlrender the engine from GHCRbash -nDNS for
oci.firebolt.ioandpx.firebolt.iois intentionally unchanged.Note
Medium Risk
Changing the default engine image host affects every install that does not override the repository, adding reliance on the Scarf gateway for pulls (with documented GHCR bypass). Runtime behavior is unchanged aside from pull path and analytics.
Overview
Restores Scarf disclosure and routes community installs through Firebolt’s OCI gateway for chart installs and default engine image pulls, while keeping contributor/CI paths on GHCR.
The chart default
engineSpec.image.repositorychanges fromghcr.io/firebolt-db/enginetooci.firebolt.io/firebolt-db/engine. User-facing docs and README now describe installing fromoci://oci.firebolt.io/..., what Scarf records (version/platform; not chart values or query data), source-IP handling, and how to opt out (direct GHCR chart +engineSpec.image.repository=ghcr.io/firebolt-db/engine). README adds Scarf badges, a Telemetry section, and the tracking pixel.CI and local dev avoid Scarf:
helm/values-dev.yamlandscripts/ci/values.yamlexplicitly set the engine repository back to GHCR. Kind e2e tooling mirrorsoci.firebolt.ioalongsideghcr.io/docker.io, andload-e2e-images.shtreatsoci.firebolt.ioengine refs like GHCR for registry-path normalization and arch checks.Reviewed by Cursor Bugbot for commit 14b0387. Bugbot is set up for automated code reviews on this repo. Configure here.