docs: replace BYOA pages with a self-managed agent guide#102
Merged
JakeSCahill merged 2 commits intoJun 17, 2026
Conversation
A self-managed agent routes its LLM and MCP calls through the AI Gateway and authenticates with a per-agent OAuth client credential. The gateway collects spend, tokens, latency, and transcripts; the agent emits no telemetry of its own. The old "Register Your Own Agent (BYOA)" page documented a model that no longer exists: the agent pushing its own OpenTelemetry to the platform. Replace it with a guide for the shipped flow: register the agent, mint a client secret on the Credentials tab, wire the LLM endpoint, the MCP endpoint, and the X-Redpanda-Genai-Conversation header from the Setup tab, and embed the five framework samples (ai-sdk-go, LangChain, CrewAI, ADK Java, ADK Go) verbatim so the page stands on its own for readers and for crawlers. Delete the two OpenTelemetry-push pages (Send BYOA Telemetry, Ingest OpenTelemetry Traces from Custom Agents) and scrub the BYO/BYOA wording from the nav, the create-agent cross-reference, the agents index, and the glossary. The product calls these agents "self-managed", so the docs do too. Verified against the implementation and the live product on ai.redpanda.com. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
👷 Deploy request for redpanda-agentic-data-plane pending review.Visit the deploys page to approve it
|
JakeSCahill
approved these changes
Jun 16, 2026
This was referenced Jun 22, 2026
docs: retire BYOA glossary term, add self-managed agent and MCP server terms
redpanda-data/docs#1759
Merged
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
3 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.
What
Replace the "Register Your Own Agent (BYOA)" page with a new "Set Up a Self-Managed Agent" guide, delete the two OpenTelemetry-push pages, and drop the "BYO/BYOA" wording for "self-managed" across the agent docs.
Why
A self-managed agent is an identity you run yourself that routes its LLM and MCP calls through the AI Gateway with a per-agent OAuth client credential. The gateway collects spend, tokens, latency, and transcripts. The agent emits no telemetry of its own.
The old pages documented a model that no longer exists: the agent pushing its own OpenTelemetry to the platform. They are wrong now, not just stale. The product UI calls these agents "self-managed", so the docs match it.
Implementation details
New page
connect/self-managed-agents.adocwalks the shipped flow end to end:serviceaccounts/<agent-id>; secrets default to a 90-day expiry./oauth/idp/token(the gateway's own OIDC provider), point the SDK base URL at/llm/v1/providers/<provider-name>, point the MCP client at/mcp/v1/<server-name>, and stamp theX-Redpanda-Genai-Conversationheader so transcripts populate.page-aliaskeeps the oldbyoa-registerURL working.Removed the OpenTelemetry-push model: deleted
monitor/byoa-telemetry.adocandmonitor/ingest-custom-traces.adoc, their nav entries, and the BYO/BYOA wording in the create-agent cross-reference, the agents index, and the glossary.Every claim was verified against the implementation and against the live product on ai.redpanda.com.
References
N/A