Skip to content

docs(orb): separate telemetry from token brokerage #1939

Description

@JSONbored

Parent: #1936

Problem

External self-hosters must not consume our GitHub API budget by default. The current system supports both direct GitHub App mode and brokered Orb mode, but the public operator story needs to make the safe ownership model explicit.

Requirements

  • Direct per-team GitHub App installation is the default and recommended model.
  • Brokered Orb token mode is private/managed beta only.
  • Orb telemetry remains available in direct App mode so website counters and aggregate outcome data still work.
  • Air-gapped mode remains available for operators who do not want telemetry.
  • Document the privacy boundary: no source code, repo names, logins, secrets, or raw review text in telemetry.

Deliverables

  • Update GitHub App setup docs to strongly prefer direct App mode.
  • Update Orb docs to separate telemetry export from token brokerage.
  • Add operational warnings for brokered mode: rate-limit blast radius, quota management, support burden, abuse/misconfiguration risk.
  • Define minimum broker safeguards before any public brokered rollout: enrollment quota, per-install concurrency, per-install rate budget, revocation path, metrics by enrollment.

Acceptance criteria

  • A beta operator can configure telemetry without using our token broker.
  • Brokered mode cannot be mistaken for the public default.
  • Docs explain exactly what data is exported and how to disable it.
  • Maintainers have a clear go/no-go checklist before allowing brokered external users.

Expected outcome

We preserve central telemetry/counters without turning every external install into our rate-limit and reliability problem.

Metadata

Metadata

Assignees

Labels

maintainer-onlyOwner-only work — yields no Gittensor points.orbGittensory Orb related - maintainer self-hosting analytics.roadmapOn the Wave-2 agent-layer roadmap board (project 9)

Projects

Status
Done

Relationships

None yet

Development

No branches or pull requests

Issue actions