Skip to content

Commit a1806ec

Browse files
paulohtb6micheleRPclaudeJakeSCahillkbatuigas
authored
adp: pkg 1 - ai gateway, transcripts, agents, mcp
* DOC-1867 AI Gateway # Conflicts: # modules/ROOT/nav.adoc * add questions for reviewers * incorporate review comments * configure AI Gateway LLM & MCP endpoints in Claude Code & similar tools * update Claude Code example + index page * revert nav title * edits * Add comprehensive AI Gateway documentation partials Added 7 new documentation files for AI Gateway: - what-is-ai-gateway.adoc: Overview, problem/solution framing, common patterns - quickstart-enhanced.adoc: Step-by-step quickstart with time markers - observability-logs.adoc: Request logs, filtering, and debugging - observability-metrics.adoc: Dashboards, analytics, and cost tracking - migration-guide.adoc: Safe migration from direct provider integration - cel-routing-cookbook.adoc: CEL routing patterns with examples - mcp-aggregation-guide.adoc: MCP aggregation and orchestration All files follow Redpanda documentation standards: - Sentence case headings - Imperative verbs for action headings - AsciiDoc format - Comprehensive placeholders for product-specific details Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * clean up cc drafts * cleanup * cleanup * Apply documentation style guide to AI Gateway pages Add personas, learning objectives, and prerequisites to all AI Gateway documentation pages. Remove DRAFT prefixes from titles and time estimates from quickstart. Fix passive voice in multiple locations. Changes: - Add page-personas attributes to all 7 files - Add learning objectives in ABCD format - Add prerequisites sections where missing - Remove "DRAFT:" from all page titles - Remove time estimates from quickstart-enhanced.adoc - Fix passive voice constructions - Improve page descriptions - Preserve all placeholder comments for future content Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Add AI Gateway client integration documentation Provide admin and user guides for configuring Claude Code, Cline, Continue.dev, Cursor IDE, and GitHub Copilot to work with AI Gateway, enabling centralized LLM routing and MCP tool aggregation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * clean up * docs: Add http_server and a2a_message connector pages * cleanup overview and quickstarts * Improve AI agents documentation readability and structure - Fix period usage in numbered steps and bold labels across all AI agent docs - Add descriptive link text to xref anchor links for better accessibility - Redesign monitor-agents.adoc reducing lists from 9 to 2, converting to prose and tables - Create observability index page - Fix broken xref from billing.adoc to observability/concepts.adoc * cc audit * Improve customer support tutorial with explicit instructions - Change negative headings to positive action-oriented headings - Add explicit 'Enter this query' instructions for each test scenario - Add guidance on what to watch for in the conversation panel - Specify when to start new sessions for context clearing * Lowercase inspector when not writing about the UI button * Restructure observability docs for better information architecture Moved monitoring how-tos into context where users need them: - Monitor Agents now in agents section - Monitor MCP Servers now in mcp/remote section - Observability concepts remain centralized as single source of truth This follows the "procedures in context, concepts centralized" pattern, reducing navigation overhead and improving task completion. Also removed unnecessary observability index page since only one page remains in that section. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Rename to Transcripts * edit for user journey * Remove sessions and tasks topics from agent documentation Sessions and tasks topics are being soft-hidden with __ prefix as they are internal implementation details. Updated documentation to focus on user-facing monitoring features (transcripts and inspector). Changes: - Remove "Agent data topics" section from concepts.adoc with schemas - Remove "Consume agent data topics" section from monitor-agents.adoc - Update troubleshooting.adoc to reference transcripts instead of topics - Update learning objective to "Track token usage and performance metrics" - Fix xref anchor links to include descriptive text - Fix shipping carrier name to comply with Google style guide Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * update nav * update nav * Refactor AI Gateway documentation for clarity and consistency Major improvements: - Rename ai-gateway.adoc to gateway-quickstart.adoc for clearer naming - Rename ai-gateway-overview.adoc to gateway-architecture.adoc - Consolidate quickstart-enhanced.adoc into gateway-quickstart.adoc - Remove 161 lines of duplicate content between what-is and architecture pages - Add page metadata (:page-topic-type:, :page-personas:, :learning-objective-N:) to all files - Convert learning objectives from bullets to required attribute format - Create BYOC version requirement partial and add to all 23 AI Gateway pages - Restructure navigation with clearer sections (Overview, Quickstart, Architecture, Observability) - Update all cross-references to renamed files This consolidation reduces content duplication, improves metadata consistency, and provides better content organization for users. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * style edits * Convert learning objectives to standard format across all AI Gateway docs Updated 13 files to comply with documentation standards for learning objectives: - Added learning objective attributes to metadata (3 files) - Converted all learning objective bullets to checklist format (* [ ]) Files updated: - admin/setup-guide.adoc - builders/connect-your-agent.adoc - builders/discover-gateways.adoc - All 10 integration guide files (admin and user variants for Claude Code, Cline, Continue, Cursor, GitHub Copilot) All 23 AI Gateway files now have proper learning objective format per team standards. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix persona metadata attribute to use correct standard Changed :page-personas: to :personas: across all 19 AI Gateway files. According to the docs-team-standards plugin (content-architecture skill), the correct attribute is :personas: without the page- prefix. Files updated: - All core AI Gateway files (index, overview, architecture, quickstart) - All guide files (CEL routing, MCP aggregation, migration, observability) - All 10 integration files (admin and user variants) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix Anthropic model identifiers in gateway quickstart examples Updated short invalid model names to official versioned identifiers: - claude-sonnet-3.5 → claude-3-5-sonnet-20241022 - anthropic/claude-sonnet-3.5 → anthropic/claude-3-5-sonnet-20241022 - anthropic/claude-opus-4 → anthropic/claude-opus-4-1-20250805 These changes ensure the quickstart examples use valid model IDs that match the format already used elsewhere in the file (line 478). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Clarify VS Code settings.json does not support native env var substitution Added IMPORTANT note in the Environment-based configuration section to warn that VS Code's .vscode/settings.json does not natively support environment variable substitution with ${VAR} syntax. The note clarifies that users must either: - Install an extension that provides variable substitution - Replace placeholders manually with actual values - Set environment variables before launching VS Code This prevents confusion about the ${GATEWAY_DEV_URL} and ${GATEWAY_DEV_ID} placeholders shown in the configuration examples. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Change Cursor MCP endpoint to use HTTPS instead of HTTP Updated the Node.js one-liner in the MCP configuration to use require('https') instead of require('http') to ensure the bearer token is sent over TLS when connecting to the gateway's MCP endpoint. Changes: - Line 269: require('http') → require('https') - Line 277: Updated description from "HTTP requests" to "HTTPS requests" This ensures secure transmission of the bearer token and other authentication credentials when Cursor connects to the AI Gateway MCP endpoint. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix inconsistent list markers in GitHub Copilot security section Changed mixed list markers in the "Code completion security" section to use consistent bullet markers. Lines 722-723 previously used '.' (ordered list) but were changed to '*' (unordered list) to match the rest of the list starting with "GitHub Copilot sends code context to LLM providers." Changes: - Line 722: '. Proprietary code...' → '* Proprietary code...' - Line 723: '. Configure organization...' → '* Configure organization...' This ensures consistent rendering and improves AsciiDoc compliance. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix SDK examples in migration guide and remove placeholder notes Updated framework integration examples with correct implementations: 1. Anthropic SDK section (lines 238-256): - Replaced incorrect Anthropic base_url override with OpenAI client - Anthropic's base_url only works with native /v1/messages API, not OpenAI-compatible gateways - Preserved use_gateway env var logic and REDPANDA_AI_GATEWAY_* names - Removed PLACEHOLDER note 2. LlamaIndex section (lines 629-638): - Added default_headers alongside additional_kwargs for gateway headers - Removed PLACEHOLDER note about header syntax 3. Vercel AI SDK section (lines 657-671): - Changed from openai() provider to createOpenAI() for custom endpoints - Uses createOpenAI() with baseURL, apiKey, and headers configuration - Removed PLACEHOLDER note about syntax verification Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Soften hard numeric claims with qualifiers across AI Gateway docs Replaced absolute percentage claims with conditional language to present them as typical or potential outcomes rather than guaranteed results: 1. what-is-ai-gateway.adoc: - Line 99: "can achieve 99.9% uptime" → "can significantly improve uptime (potentially up to 99.9% in some configurations)" - Line 107: "reduces token usage by 80-90%" → "often reduces token usage by 80-90% depending on your configuration and the number of tools aggregated" 2. mcp-aggregation-guide.adoc: - Line 16: "80-90% fewer tokens" → "Often 80-90% fewer tokens (depending on configuration)" - Line 152: "80-90% reduction" → "Typically 80-90% reduction" - Line 269: "Still 80-90% lower" → "Often 80-90% lower" - Line 335: "Expected Results: 80-90% reduction" → "Typically 80-90% reduction" 3. gateway-architecture.adoc: - Line 123: "80-90% token reduction" → "often 80-90% token reduction depending on configuration" These changes ensure claims are presented as conditional outcomes that depend on configuration, rather than absolute guarantees. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Convert persona restructuring plan from Markdown to AsciiDoc Converted AI_GATEWAY_PERSONA_RESTRUCTURING_PLAN.md to proper AsciiDoc format: - Renamed to lowercase: ai-gateway-persona-restructuring-plan.adoc - Converted Markdown headers (# ## ###) to AsciiDoc (= == ===) - Converted Markdown tables to AsciiDoc table format with proper column specs - Converted Markdown code blocks to AsciiDoc [source,text] blocks - Converted Markdown bold (**text**) to AsciiDoc bold (*text*) - Added blank lines before and after all tables and code blocks - Fixed all code blocks to use proper language annotations (text for trees) - Removed old markdown file All tables now have proper blank lines and all fenced code blocks have language annotations, fixing MD058/MD040 violations. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove unused ai-gateway.png image file Deleted modules/shared/partials/ai-gateway.png as it's no longer needed. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove persona restructuring planning document Deleted ai-gateway-persona-restructuring-plan.adoc as it was an internal planning document that isn't referenced anywhere in the published docs. Planning documents don't need to be in the documentation tree. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Update Claude Code config to match Anthropic MCP schema - Change config file path from ~/.claude/config.json to ~/.claude.json - Add mention of project-level .mcp.json alternative - Replace "transport": "http" with "type": "http" per MCP spec - Remove undocumented apiProviders sections from all examples - Remove request retry configuration section (used apiProviders) - Remove troubleshooting item about missing apiProviders - Update all troubleshooting commands to use correct file path Files updated: - claude-code-admin.adoc - claude-code-user.adoc Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Add note about environment variable interpolation in mcpServers Clarify that Claude Code supports ${VAR} syntax for environment variable interpolation in the mcpServers section, specifying which variables will be resolved at runtime (REDPANDA_GATEWAY_URL, REDPANDA_GATEWAY_ID, REDPANDA_API_KEY). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Update Cline config to use official extension settings Remove unofficial VS Code settings keys (cline.apiProvider, cline.apiBaseUrl, cline.customHeaders) and document that API/provider configuration is managed via Cline extension global state, not settings.json. Replace MCP configuration to use cline_mcp_settings.json with official schema: - Change "transport": "http" to "type": "streamableHttp" - Remove "cline.mcpServers" wrapper (use "mcpServers" directly) - Add "Cline > Mcp: Mode" toggle for MCP enablement - Document Cline UI and cline_mcp_settings.json as config methods Update configuration scope section to reflect extension global state storage model instead of VS Code settings.json levels. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Replace hardcoded token with env var in curl example Replace "YOUR_API_TOKEN" with "${REDPANDA_API_TOKEN}" environment variable in the curl Authorization header to avoid secret scanner false positives. Add inline comment and NOTE block to inform users they must set the environment variable before running the command. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Update Continue.dev config to current YAML standard Convert configuration from JSON to YAML format: - Change file name from ~/.continue/config.json to ~/.continue/config.yaml - Convert all JSON examples to YAML syntax - Update models, tabAutocompleteModel, apiBase, apiKey references Update MCP configuration to official schema: - Change modelContextProtocolServers (plural) to modelContextProtocolServer (singular) - Replace transport type "http" with "streamable-http" (valid value) - Add recommended directory-based configuration using ~/.continue/mcpServers/ - Provide alternative inline configuration in config.yaml Document that Continue.dev automatically discovers MCP server configurations in the mcpServers/ directory, which is the preferred configuration method. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix Continue.dev environment variable interpolation syntax Replace legacy JSON config with YAML using correct secrets interpolation: - Change from ${VAR} to ${{ secrets.VAR }} syntax - Update models -> apiKey, apiBase with secrets.REDPANDA_API_KEY and secrets.REDPANDA_GATEWAY_URL - Update requestOptions.headers.rp-aigw-id with secrets.REDPANDA_GATEWAY_ID - Update experimental.modelContextProtocolServer fields (changed from plural to singular per schema) - Change transport type from "http" to "streamable-http" - Replace transport.url, Authorization header, and rp-aigw-id header with secrets interpolation Add IMPORTANT note that ${VAR} syntax from config.json is not supported and will be treated as literal strings in Continue.dev. Replace shell environment variable exports with instructions to set secrets in Continue.dev settings UI. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix Cursor settings.json environment variable handling Add IMPORTANT note that VS Code settings.json does not support ${VAR} interpolation - such placeholders are treated as literal strings. Provide two alternatives for handling sensitive credentials: Option 1: Script-based generation - Add bash script that reads environment variables and generates settings.json with actual values for cursor.overrideOpenAIBaseUrl, cursor.overrideOpenAIApiKey, and openai.additionalHeaders - Add PowerShell script for Windows users with ConvertTo-Json - Include instructions to run script before launching Cursor Option 2: Manual value replacement - Show example with concrete placeholder values users must replace - Add security note about file permissions (chmod 600) Remove misleading instructions to set environment variables and launch from terminal, as this does not enable interpolation in settings.json. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix GitHub Copilot configuration settings and flow Update Option 1 (built-in custom models): - Change github.copilot.advanced.customModels to correct setting: github.copilot.chat.customOAIModels (experimental chat OAI models) - Restructure configuration as array instead of nested object - Add IMPORTANT note that API keys/headers must be configured via Copilot Chat UI, not settings.json - Replace environment variable instructions with Copilot Chat → Manage Models UI flow: Add Model → Select provider → Enter API key and custom headers (rp-aigw-id) - Remove references to non-working environment variable approach Update Option 2 (OAI Compatible Provider extension): - Replace incorrect oai.provider.* settings with actual extension settings: oaicopilot.baseUrl and oaicopilot.models - Remove non-existent useOAIProvider setting from configuration - Add IMPORTANT note that API keys/headers are NOT set in settings.json - Document correct flow: Copilot Chat → Manage Models → Configure provider → Enter API key and custom headers - Remove environment variable instructions that don't apply - Remove unnecessary window reload step Both options now correctly document that users must use the Copilot Chat → Manage Models UI to configure API keys and custom headers. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove duplicate rp-aigw-id from LlamaIndex example Remove rp-aigw-id from additional_kwargs in the LlamaIndex OpenAI client configuration. The header was being set twice - once in additional_kwargs (which goes in the request body) and once in default_headers (which sets HTTP headers). Keep only the default_headers configuration to correctly set the rp-aigw-id as an HTTP header. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix Continue.dev config file references to use YAML Update security guidance section to reference config.yaml instead of config.json: - Change "stores the API token in plain text in config.json" to config.yaml - Update version control warning to reference config.yaml - Update chmod example from ~/.continue/config.json to ~/.continue/config.yaml Keep guidance points the same: never commit the config file, restrict filesystem permissions, and rotate tokens if compromised. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix Continue.dev MCP server schema in config.yaml examples Update Continue.dev documentation to use the correct MCP server configuration schema: - Change from experimental.modelContextProtocolServer (singular) to mcpServers (plural) at root level - Add array syntax with dash (-) before transport configuration - Update continue-user.adoc inline config.yaml examples (2 instances) - Update continue-admin.adoc inline config.yaml example - Fix troubleshooting references to use new mcpServers schema - Convert JSON config example to YAML with new schema for consistency The new schema allows multiple MCP servers to be configured and aligns with Continue.dev's current config.yaml structure. Directory-based configuration in ~/.continue/mcpServers/ already uses correct schema. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix unsupported ${VAR} interpolation in Continue.dev project config Replace misleading ${VAR} syntax in .continuerc.json example with explicit placeholder text (your_project_api_key_here, etc.) to avoid confusion. Add IMPORTANT note explaining that .continuerc.json does not support environment variable interpolation and must use hardcoded values. Direct users to config.yaml with ${{ secrets.* }} syntax or config.ts for programmatic environment access as alternatives. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Improve Continue.dev documentation clarity and compliance Address critical documentation issues identified in audit: 1. Remove checkboxes from learning objectives in both user and admin guides per content architecture standards 2. Add config file format clarification section explaining JSON vs YAML, when each is required/recommended, helping users understand which format to choose 3. Fix environment variable syntax documentation: - Add explicit anchor [[configure-env-vars]] for cross-references - Clarify ${{ secrets.* }} is YAML-only - Explain config.json does not support any variable interpolation - Clarify ${VAR} syntax is treated as literal string 4. Add security warning in admin guide about hardcoded tokens with cross-reference to environment variable interpolation best practices 5. Update admin guide to acknowledge both JSON and YAML formats are supported, explaining why YAML is recommended for MCP features These changes eliminate confusion about config file formats and improve security guidance for production deployments. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove checkboxes and periods from learning objectives across all integration files Apply content architecture standards to all AI Gateway integration documentation: - Remove [ ] checkbox formatting from learning objectives - Remove trailing periods from objective fragments Files updated: - cursor-user.adoc, cursor-admin.adoc - github-copilot-user.adoc, github-copilot-admin.adoc - claude-code-user.adoc, claude-code-admin.adoc - cline-user.adoc, cline-admin.adoc Learning objectives should be simple list items without interactive elements or punctuation for fragments. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Revert "Remove checkboxes and periods from learning objectives across all integration files" This reverts commit f754065. Checkboxes [ ] ARE the doc team standard for learning objectives in this repository, as evidenced by the MCP documentation pages and other content. The audit agent was incorrect in recommending their removal. Restored checkboxes and periods to learning objectives in all integration files to match the established pattern: * [ ] Learning objective text. Examples of this pattern in the repo: - modules/ai-agents/pages/mcp/remote/quickstart.adoc - modules/ai-agents/pages/mcp/remote/concepts.adoc - modules/ai-agents/pages/mcp/local/configuration.adoc * update nav * Doc UI and update terminology for transcripts * Add transcripts UI doc to nav * Add fraud agent tutorial * Improve readability * Update modules/ai-agents/examples/agents/fraud-agent-prompt.txt Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions * Apply suggestions * update cloud overview adp focus * Update cloud overview with latest ADP content from CTO Tech Talk demo Align messaging with public demo content: emphasize manufacturing use case, add multi-agent architecture, highlight MCP server security features (injection attack prevention), strengthen interoperability messaging, and remove OXLA references not yet in public materials. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * cleanup * minor edits * Apply suggestions from SME review * minor edit * fix nav * minor edit * Apply suggestion from @JakeSCahill * Fix example * Fix code review feedback - Parse agent JSON response in fraud-detection-routing pipeline - Add .value accessor to rpk jq filter - Standardize country codes to ISO alpha-2 format - Make model references evergreen - Add Content-Type headers to HTTP POST requests - Normalize MCP tool response structures - Add low/none severity counts to risk indicators - Ensure consistent response schema in fallback branches * Apply suggestions * Apply suggestions * AWS only & what's new blurb * AWS only * Apply feedback * Update modules/ai-agents/pages/agents/overview.adoc Co-authored-by: Michele Cyran <michele@redpanda.com> * Remove alias * Remove incorrectly added files from previous commit * Integrate AI Gateway into agent documentation - Replace API key prerequisites with AI Gateway requirement - Add gateway selection before provider/model selection - Remove 'Add API keys as secrets' section from create-agent - Update all tutorials to use gateway-based authentication * Update local-antora-playbook.yml * Replace 'Cloud UI' with 'Cloud Console' throughout ai-agents docs * Update MCP overview * Remove search and add placeholder for filtering functionality * Clarify trace format * Start telemetry doc for BYOA * Add byoa telemetry to nav tree * conditionalize out content not for package 1 * Simplify examples * Fix label * Fix label * Fix label * force build * update nav.adoc * fix nav * base * DOC-1901 * add google AI * Change filename and update with UI changes * Update nav tree with correct filename * add AI Hub documentation - Add 4 new pages: gateway modes concept, configure AI Hub, eject to custom mode, use AI Hub gateway - Add 2 reusable partials: mode indicator, preference toggles - Update 5 existing pages with AI Hub mode content - Document 17 routing rules, 6 backend pools, 6 preference toggles - Update navigation with new AI Hub pages - Fix all API paths and ensure docs team standards compliance Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix nav tree and add xrefs * Minor edits to concepts * Minor edit * Fix build errors * Minor edit * Update quickstart.adoc * adp: add authorization docs * adjust to standards * Update modules/ai-agents/partials/service-account-authorization.adoc * add glossterms * use glossterms * update cloud overview adp focus * Update cloud overview with latest ADP content from CTO Tech Talk demo Align messaging with public demo content: emphasize manufacturing use case, add multi-agent architecture, highlight MCP server security features (injection attack prevention), strengthen interoperability messaging, and remove OXLA references not yet in public materials. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * cleanup * minor edits * minor edit * minor edit * AWS only & what's new blurb # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc * incorporate review feedback + add glossary terms * Fix OTLP trace ingestion docs and add code examples (#502) - Fix endpoint URL format: use pipeline URL pattern instead of internal ports (4317/4318) - Simplify pipeline YAML config with Cloud-standard env vars - Add authentication section with link to Cloud API auth docs - Add Go examples for both HTTP and gRPC transports - Add gRPC examples for Python and Node.js - Remove internal implementation details users don't need Co-authored-by: Johannes Brüderl <johannes@redpanda.fritz.box> * Edit for length * Address SME feedback * Trim Transcripts UI doc * Trim concepts content * Polish byoa telemetry doc * clean placeholders & move integrations to partials * fix xrefs to integrations * Add glossary terms * Fix gloss terms * Resolve 23 PLACEHOLDERs across AI Gateway docs Replace model="auto" with realistic model names in CEL examples, fix UI navigation paths to use Agentic AI sidebar structure, confirm streaming and response format compatibility, uncomment verification command, comment out unverified CEL sections (A/B testing, time-based routing, reject), revise geographic routing to use different providers, and update observability integrations to confirmed Prometheus + OpenTelemetry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * style edits * Update model versions and add Gemini provider support Update all AI Gateway documentation to use latest model versions: - OpenAI: gpt-5.2, gpt-5.2-mini (was gpt-4o, gpt-4o-mini) - Anthropic: claude-sonnet-4.5, claude-opus-4.6 (was claude-sonnet-3.5, claude-opus-4) - Add Google Gemini: gemini-2.0-flash, gemini-2.0-pro Updated 27 files including core docs, admin/builder guides, integration guides, CEL routing examples, and code samples across all documentation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Move AI Hub content to partials for future release Move AI Hub documentation to partials folder to preserve content but prevent rendering in Package 1 release: - Move configure-ai-hub.adoc, eject-to-custom-mode.adoc, use-ai-hub-gateway.adoc, gateway-modes.adoc to partials/ai-hub/ - Wrap all xrefs to AI Hub pages with ifdef::ai-hub-available[] conditionals - Remove AI Hub pages from nav.adoc - Update 7 files with conditional xrefs: gateway-quickstart, setup-guide, discover-gateways, what-is-ai-gateway, gateway-architecture, ai-hub-preference-toggles AI Hub content preserved for future Package 2 release. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * conditionalizing cleanup * conditionalizing cleanup * Address feedback * Update modules/ai-agents/pages/agents/architecture-patterns.adoc Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> * Address feedback * Address feedback * Reorganize http/grpc section and fix more gloss terms * edits * Remove rp-aigw-id header references, update to URL-based gateway ID Gateway ID is now embedded in the endpoint URL path instead of passed as a separate rp-aigw-id HTTP header. Updated all code examples, UI navigation, and documentation across 22 files. Also updated observability dashboard references to point to the gateway Overview tab where applicable, and commented out references to UI features not yet available. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Update docs to match current AI Gateway UI - Update MCP server fields to match Create MCP Server dialog (Server ID, Display Name, Server Address, Defer Loading Override, Forward OIDC Token Override) - Update orchestrator section to reflect system-managed config with configurable blocked tool patterns - Update deferred loading config to use per-server Defer Loading Override dropdown instead of gateway-level toggle - Update observability references to point to gateway Overview tab - Comment out references to UI features not yet available Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * rename MCP Gateway chapter * improved messaging from Alex * improved messaging from Alex * improved messaging from Alex for AI Gateway * improved messaging from Alex for MCP * improved messaging from Alex + new ADP overview * delete original overview * fix index.adoc * cleanup * style edits * Make observability intros more evaluator-friendly and outcome-based * Remove file duplicated after rename to transcripts.adoc * Add new log gloss term * Plain language * Minor intro section tweak * add LA and position admonition consistently * add practical business value of ADP to overview * cleanup * minor edits * coderabbit fix * fix incorrect CEL field names to use request.body.* schema Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix invalid Cursor MCP config key: transport -> type: streamable-http Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * coderabbit fix in partial * Update modules/ai-agents/examples/mcp-tools/inputs/stream_processing.yaml Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix Claude Code LLM routing to use environment variables Replace non-existent claude config set flags with ANTHROPIC_BASE_URL and ANTHROPIC_AUTH_TOKEN environment variables. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix OTLP status code values: 0=UNSET, 1=OK, 2=ERROR Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix CEL request path and add safe-access guard in cline-user Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix jq selector to access .value wrapper consistently Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * clarify env var interpolation scope: .mcp.json only, not ~/.claude.json Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: JakeSCahill <jake@redpanda.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Co-authored-by: Kat Batuigas <kbatuigas@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Johannes Brüderl <johannes.bruederl@gmail.com> Co-authored-by: Johannes Brüderl <johannes@redpanda.fritz.box> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> Co-authored-by: Paulo Borges <paulohtb@Paulos-MacBook-Pro.local>
1 parent 39a8a57 commit a1806ec

151 files changed

Lines changed: 23680 additions & 1091 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
1-
name: Test MCP Examples
1+
name: Test Pipeline Examples
22

33
on:
4-
push:
5-
branches:
6-
- main
7-
paths:
8-
- 'modules/ai-agents/examples/**/*.yaml'
9-
- 'modules/ai-agents/examples/test-mcp-examples.sh'
104
pull_request:
115
branches:
126
- main
137
paths:
148
- 'modules/ai-agents/examples/**/*.yaml'
15-
- 'modules/ai-agents/examples/test-mcp-examples.sh'
9+
- 'modules/ai-agents/examples/**/*.sh'
10+
- 'modules/develop/examples/**/*.yaml'
11+
- 'modules/develop/examples/**/*.sh'
1612

1713
jobs:
1814
test-all-examples:
19-
name: Test All MCP Examples
15+
name: Test All Pipeline Examples
2016
runs-on: ubuntu-latest
2117

2218
steps:
@@ -39,15 +35,33 @@ jobs:
3935
sudo wget -qO /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64
4036
sudo chmod +x /usr/local/bin/yq
4137
42-
- name: Make test script executable
43-
run: chmod +x modules/ai-agents/examples/test-mcp-examples.sh
38+
- name: Make test scripts executable
39+
run: |
40+
find modules/ai-agents/examples -name "*.sh" -exec chmod +x {} \;
41+
find modules/develop/examples -name "*.sh" -exec chmod +x {} \; 2>/dev/null || true
42+
43+
- name: Run MCP tools tests
44+
run: |
45+
cd modules/ai-agents/examples/mcp-tools
46+
./test-mcp-tools.sh
47+
48+
- name: Run ai-agents pipeline tests
49+
run: |
50+
cd modules/ai-agents/examples/pipelines
51+
./test-pipelines.sh
4452
45-
- name: Run MCP examples tests
53+
- name: Run cookbook tests
4654
run: |
47-
cd modules/ai-agents/examples
48-
./test-mcp-examples.sh
55+
for dir in modules/develop/examples/cookbooks/*/; do
56+
if [[ -f "${dir}test-"*".sh" ]]; then
57+
echo "Testing ${dir}..."
58+
cd "${dir}"
59+
./test-*.sh
60+
cd - > /dev/null
61+
fi
62+
done
4963
5064
- name: Test Summary
5165
if: always()
5266
run: |
53-
echo "::notice title=MCP Examples Testing::All Cloud MCP examples have been validated"
67+
echo "::notice title=Pipeline Examples Testing::All pipeline examples have been validated"

docs-data/personas.yaml

Lines changed: 230 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,77 @@
22
#
33
# These personas represent the target audience for Redpanda Cloud documentation.
44
# Use these when assigning :personas: attributes to documentation pages.
5+
#
6+
# This persona set covers two domains:
7+
# 1. Streaming/Data Platform: Real-time data streaming, connectors, pipelines
8+
# 2. Agentic Data Platform (ADP): AI agent development, governance, enterprise AI adoption
59

610
schema_version: "1.0"
711
repository: cloud-docs
812

913
personas:
10-
- id: app_developer
11-
name: Application Developer
12-
description: Builds applications that produce and consume data from Redpanda Cloud
13-
experience_level: intermediate
14+
# ============================================================================
15+
# TIER 1: Executive & Governance
16+
# ============================================================================
17+
18+
- id: executive
19+
name: Executive Stakeholder
20+
description: CIO/CAIO/Head of AI Strategy driving enterprise AI adoption and governance
21+
experience_level: executive
1422
goals:
15-
- Connect applications to Redpanda Cloud clusters
16-
- Produce and consume messages reliably
17-
- Implement proper error handling and retries
18-
- Optimize client performance
23+
- Drive enterprise-wide AI adoption strategy
24+
- Ensure ROI on AI investments
25+
- Establish governance framework for agent deployments
26+
- Manage cost and resource allocation
27+
- Ensure compliance with organizational policies
1928
pain_points:
20-
- Authentication and connection configuration
21-
- Understanding Kafka client options
22-
- Debugging connectivity issues
23-
- Choosing the right client library
29+
- Lack of visibility into agent usage and costs
30+
- Difficulty enforcing governance at scale
31+
- Unclear ROI metrics for AI initiatives
32+
- Risk of shadow AI deployments
33+
- Integration with existing enterprise systems
2434
content_preferences:
25-
- Working code examples in multiple languages
26-
- Connection configuration templates
27-
- Client library comparisons
28-
- Performance tuning guides
35+
- High-level governance frameworks
36+
- ROI and cost analysis
37+
- Compliance and audit capabilities
38+
- Executive dashboards and reporting
39+
- Strategic planning guides
2940
typical_content_types:
30-
- how-to
31-
- tutorial
41+
- overview
42+
- concepts
43+
- best-practices
44+
45+
- id: security_leader
46+
name: Security & Risk Leader
47+
description: CISO/Compliance Officer protecting systems and enforcing data protection policies
48+
experience_level: advanced
49+
goals:
50+
- Enforce agent policy and access controls
51+
- Maintain audit trails for compliance
52+
- Protect sensitive data and credentials
53+
- Manage risk across agent deployments
54+
- Ensure regulatory compliance
55+
pain_points:
56+
- Agent access to sensitive systems
57+
- Lack of visibility into agent actions
58+
- Difficult to audit agent behavior
59+
- Credential management and rotation
60+
- Compliance with data protection regulations
61+
content_preferences:
62+
- Security architecture patterns
63+
- Policy enforcement mechanisms
64+
- Audit trail documentation
65+
- Compliance certification guides
66+
- Incident response procedures
67+
typical_content_types:
68+
- concepts
3269
- reference
70+
- best-practices
71+
- troubleshooting
72+
73+
# ============================================================================
74+
# TIER 2: Platform Operations
75+
# ============================================================================
3376

3477
- id: platform_admin
3578
name: Platform Administrator
@@ -55,47 +98,97 @@ personas:
5598
- reference
5699
- best-practices
57100

58-
- id: data_engineer
59-
name: Data Engineer
60-
description: Builds data pipelines using managed connectors and Redpanda Connect
61-
experience_level: intermediate
101+
- id: ai_platform_engineer
102+
name: AI/ML Platform Engineer
103+
description: Operates agent infrastructure, runtimes, and connectivity with governance controls
104+
experience_level: advanced
62105
goals:
63-
- Set up managed connectors to move data between systems
64-
- Transform and route data reliably
65-
- Monitor connector and pipeline health
66-
- Handle errors and retries
106+
- Deploy and operate agent runtime infrastructure
107+
- Configure governance controls and policies
108+
- Monitor agent performance and resource usage
109+
- Onboard and manage MCP servers
110+
- Ensure agent observability and debugging
67111
pain_points:
68-
- Connector configuration complexity
69-
- Debugging failed connectors
70-
- Schema management and evolution
71-
- Performance tuning
112+
- Complex agent runtime configuration
113+
- Difficult to troubleshoot agent failures
114+
- Managing agent resource allocation
115+
- Integrating governance with existing tools
116+
- Scaling agent infrastructure
72117
content_preferences:
73-
- Connector setup guides
74-
- Transformation examples
75-
- Error handling patterns
76-
- Monitoring and troubleshooting
118+
- Infrastructure setup guides
119+
- Governance configuration patterns
120+
- Observability and monitoring setup
121+
- Performance tuning documentation
122+
- Troubleshooting workflows
77123
typical_content_types:
78124
- how-to
79-
- cookbook
125+
- reference
80126
- troubleshooting
127+
- best-practices
81128

82-
- id: ai_agent_developer
83-
name: AI Agent Developer
84-
description: Builds AI agents and integrations using MCP tools and LLM frameworks
129+
# ============================================================================
130+
# TIER 3: Builders & Developers
131+
# ============================================================================
132+
133+
- id: app_developer
134+
name: Application Developer
135+
description: Builds applications that produce and consume data from Redpanda Cloud
85136
experience_level: intermediate
86137
goals:
138+
- Connect applications to Redpanda Cloud clusters
139+
- Produce and consume messages reliably
140+
- Implement proper error handling and retries
141+
- Optimize client performance
142+
pain_points:
143+
- Authentication and connection configuration
144+
- Understanding Kafka client options
145+
- Debugging connectivity issues
146+
- Choosing the right client library
147+
content_preferences:
148+
- Working code examples in multiple languages
149+
- Connection configuration templates
150+
- Client library comparisons
151+
- Performance tuning guides
152+
typical_content_types:
153+
- how-to
154+
- tutorial
155+
- reference
156+
157+
- id: agent_developer
158+
name: Agent Developer
159+
description: Builds AI agents, agentic workflows, and MCP tools that integrate with Redpanda Cloud and ADP
160+
experience_level: intermediate
161+
goals:
162+
# MCP and streaming integration
87163
- Create MCP tools that AI assistants can discover and use
88164
- Deploy MCP servers to Redpanda Cloud
89165
- Integrate with AI/LLM applications
90166
- Debug agent-tool interactions
167+
# Agentic workflows and governed deployment
168+
- Build agents and workflows that solve business problems
169+
- Use ADP catalog, templates, and curated datasets
170+
- Design reasoning patterns and tool interactions
171+
- Deploy agents into governed runtime
91172
pain_points:
173+
# MCP and integration challenges
92174
- MCP configuration syntax
93175
- Testing tools before deployment
94176
- Limited AI-specific examples
177+
# ADP and governance challenges
178+
- Hard to discover existing templates, MCP servers, datasets
179+
- Unclear access policies
180+
- Brittle multi-step integrations
181+
- Inconsistent testing/debugging environments
95182
content_preferences:
183+
# Code examples and patterns
96184
- Working code examples with AI context
97185
- Testing and debugging workflows
98186
- Integration patterns
187+
# Catalog and governance
188+
- Rich catalog of agent templates and tools
189+
- Governance introspection (what agent can/can't do)
190+
- Replay-based debugging
191+
- Streamlined deployment workflows
99192
typical_content_types:
100193
- tutorial
101194
- how-to
@@ -127,6 +220,81 @@ personas:
127220
- reference
128221
- best-practices
129222

223+
# ============================================================================
224+
# TIER 4: Data & Knowledge Management
225+
# ============================================================================
226+
227+
- id: data_engineer
228+
name: Data Engineer
229+
description: Builds data pipelines with managed connectors AND creates curated datasets for agent consumption
230+
experience_level: intermediate
231+
goals:
232+
# Data movement and pipelines
233+
- Set up managed connectors to move data between systems
234+
- Transform and route data reliably
235+
- Monitor connector and pipeline health
236+
- Handle errors and retries
237+
# Agent-ready datasets and RAG
238+
- Create agent-ready datasets with federated SQL
239+
- Ensure data quality and freshness for agents
240+
- Expose data safely through governed views
241+
- Provide clean RAG context via MCP servers
242+
pain_points:
243+
# Connector and pipeline challenges
244+
- Connector configuration complexity
245+
- Debugging failed connectors
246+
- Schema management and evolution
247+
- Performance tuning
248+
# Data curation for agents
249+
- Siloed data across sources
250+
- Fragile RAG sources
251+
- Schema drift
252+
- Difficulty providing agent-ready datasets quickly
253+
content_preferences:
254+
# Connector and transformation
255+
- Connector setup guides
256+
- Transformation examples
257+
- Error handling patterns
258+
- Monitoring and troubleshooting
259+
# Federated data and RAG
260+
- Federated SQL query examples
261+
- Governed view patterns
262+
- RAG context design
263+
- Data lineage visualization
264+
typical_content_types:
265+
- how-to
266+
- cookbook
267+
- troubleshooting
268+
- reference
269+
270+
- id: knowledge_manager
271+
name: Knowledge & Operations Manager
272+
description: Maintains organizational documentation and knowledge bases for agent consumption
273+
experience_level: intermediate
274+
goals:
275+
- Ingest and maintain organizational knowledge bases
276+
- Ensure content freshness and accuracy
277+
- Optimize vector search for agent queries
278+
- Manage knowledge base access and permissions
279+
pain_points:
280+
- Stale or outdated documentation
281+
- Difficult to index and search content
282+
- Managing content from multiple sources
283+
- Ensuring agent retrieval accuracy
284+
content_preferences:
285+
- KB ingestion workflows
286+
- Vector search optimization guides
287+
- Content freshness strategies
288+
- Access control patterns
289+
typical_content_types:
290+
- how-to
291+
- best-practices
292+
- troubleshooting
293+
294+
# ============================================================================
295+
# TIER 5: Evaluation & End Users
296+
# ============================================================================
297+
130298
- id: evaluator
131299
name: Technical Evaluator
132300
description: Assessing Redpanda Cloud for their organization
@@ -150,4 +318,27 @@ personas:
150318
- overview
151319
- concepts
152320
- tutorial
153-
- get-started
321+
322+
- id: business_user
323+
name: Business End User
324+
description: Uses agent-powered automations to complete business tasks
325+
experience_level: beginner
326+
goals:
327+
- Complete tasks efficiently using agents
328+
- Understand what agents can and cannot do
329+
- Trust agent recommendations and actions
330+
- Report issues when agents fail
331+
pain_points:
332+
- Unclear agent capabilities
333+
- Unexpected agent behavior
334+
- Lack of transparency in agent actions
335+
- Difficulty getting help when agents fail
336+
content_preferences:
337+
- Simple, task-oriented guides
338+
- Agent capability overviews
339+
- Troubleshooting for common issues
340+
- Trust and transparency documentation
341+
typical_content_types:
342+
- overview
343+
- how-to
344+
- troubleshooting

0 commit comments

Comments
 (0)