Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
* xref:ROOT:index.adoc[Overview]
* xref:get-started:byoc-quickstart.adoc[Quickstart]
* xref:get-started:byoc-quickstart.adoc[ADP Quickstart]
* xref:agents:index.adoc[Agents]
** xref:agents:overview.adoc[Overview]
** xref:agents:quickstart.adoc[Quickstart]
** xref:agents:quickstart.adoc[AI Agent Quickstart]
** xref:agents:concepts.adoc[Concepts]
** xref:agents:a2a-concepts.adoc[Agent-to-Agent Concepts]
** xref:agents:create-agent.adoc[Create a Declarative Agent]
Expand Down Expand Up @@ -41,7 +41,7 @@
*** xref:mcp:managed/zendesk.adoc[Zendesk]
* xref:ai-gateway:index.adoc[AI Gateway]
** xref:ai-gateway:overview.adoc[Overview]
** xref:ai-gateway:gateway-quickstart.adoc[Quickstart]
** xref:ai-gateway:gateway-quickstart.adoc[AI Gateway Quickstart]
** xref:ai-gateway:gateway-architecture.adoc[Architecture]
** xref:ai-gateway:configure-provider.adoc[Configure Your LLM Provider]
*** xref:ai-gateway:bedrock-setup.adoc[Set Up AWS Bedrock]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ Causes and solutions:
* **Expired token**: Generate a new API token and update the GitHub Copilot configuration
* **Network connectivity**: Verify the cluster endpoint is accessible from the client network
* **Provider not enabled**: Ensure at least one provider is enabled and has models in the catalog
* **SSL/TLS issues**: Verify the cluster has valid SSL certificates
* **TLS issues**: Verify the cluster has valid TLS certificates
* **Organization policy blocking custom endpoints**: Check GitHub organization settings

=== Model not found errors
Expand Down
8 changes: 4 additions & 4 deletions modules/agents/pages/quickstart.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= AI Agent Quickstart
:page-aliases: cloud-data-platform:ai-agents:agents/quickstart.adoc
:description: Create your first AI agent in ADP that generates and publishes event data through natural language commands.
:page-topic-type: tutorial
:page-topic-type: quickstart
:personas: agent_builder
:learning-objective-1: Create an AI agent in ADP that uses MCP tools
:learning-objective-2: Configure the agent with a system prompt and model selection
Expand All @@ -21,7 +21,7 @@ After completing this quickstart, you will be able to:

* xref:ai-gateway:gateway-quickstart.adoc[AI Gateway configured] with at least one LLM provider enabled (OpenAI, Anthropic, Google AI, or AWS Bedrock)

* Completed the xref:mcp:create-server.adoc[Remote MCP Quickstart] to create an MCP server with the following tools deployed:
* An MCP server created by following xref:mcp:create-server.adoc[Create an MCP Server], with the following tools deployed:
+
** `generate_input`: Generates fake user event data
** `redpanda_output`: Publishes data to Redpanda topics
Expand All @@ -34,7 +34,7 @@ An Event Data Manager agent that:
* Publishes events to Redpanda topics
* Understands natural language requests like "Generate 5 login events and publish them"

The agent orchestrates the `generate_input` and `redpanda_output` tools you created in the Remote MCP quickstart.
The agent orchestrates the `generate_input` and `redpanda_output` tools you created in xref:mcp:create-server.adoc[].

== Create the agent

Expand Down Expand Up @@ -87,7 +87,7 @@ Response format:
. Select MCP tools:
+
* Click *Add MCP Server*
* Select the `event-data-generator` server (created in the MCP quickstart)
* Select the `event-data-generator` server you created in xref:mcp:create-server.adoc[]
* Check both tools:
** `generate_input`
** `redpanda_output`
Expand Down
2 changes: 1 addition & 1 deletion modules/ai-gateway/pages/admin/setup-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The infrastructure that serves the model differs based on the provider you selec

. Click *Save changes*.

Only enabled models will be accessible through gateways. You can enable or disable models at any time without affecting existing gateways.
Only enabled models are accessible through gateways. You can enable or disable models at any time without affecting existing gateways.

=== Model naming convention

Expand Down
2 changes: 1 addition & 1 deletion modules/ai-gateway/pages/bedrock-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ TIP: Don't reuse an existing IAM user. A dedicated user makes it easy to rotate

== Generate access keys

Generate the access keys AI Gateway will use:
Generate the access keys AI Gateway uses:

[,bash]
----
Expand Down
12 changes: 6 additions & 6 deletions modules/ai-gateway/pages/gateway-quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Providers represent upstream LLM services and their associated credentials. Prov
. Navigate to *Agentic* > *AI Gateway* > *Providers*.
. Select a provider (for example, OpenAI, Anthropic, Google AI, AWS Bedrock).
. On the Configuration tab, click *Add configuration* and enter the provider's credentials (API key for OpenAI, Anthropic, and Google AI; AWS access key and secret for Bedrock).
. Verify the provider status shows "Active".
. Verify the provider status shows as active.

== Enable models

After enabling a provider, enable the specific models you want to make available through your gateways.

. Navigate to *Agentic* > *AI Gateway* > *Models*.
. Enable the models you want to use (for example, `gpt-5.2-mini`, `claude-sonnet-4.5`, `claude-opus-4.6`).
. Verify the models appear as "Enabled" in the model catalog.
. Verify the models appear as enabled in the model catalog.

TIP: Different providers have different reliability and cost characteristics. When choosing models, consider your use case requirements for quality, speed, and cost.

Expand Down Expand Up @@ -196,10 +196,10 @@ Confirm your request was routed through AI Gateway.

. On the *Overview* tab, check the aggregate metrics:
+
* *Total Requests*: Should have incremented
* *Total Tokens*: Shows combined input and output tokens
* *Total Cost*: Estimated spend across all requests
* *Avg Latency*: Average response time in milliseconds
* Total Requests: Should have incremented.
* Total Tokens: Shows combined input and output tokens.
* Total Cost: Estimated spend across all requests.
* Avg Latency: Average response time in milliseconds.

. Scroll to the *Models* table to see per-model statistics:
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ Causes and solutions:
* **Expired token**: Generate a new API token and update the GitHub Copilot configuration
* **Network connectivity**: Verify the cluster endpoint is accessible from the client network
* **Provider not enabled**: Ensure at least one provider is enabled and has models in the catalog
* **SSL/TLS issues**: Verify the cluster has valid SSL certificates
* **TLS issues**: Verify the cluster has valid TLS certificates
* **Organization policy blocking custom endpoints**: Check GitHub organization settings

=== Model not found errors
Expand Down
2 changes: 1 addition & 1 deletion modules/mcp/pages/managed/metabase.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ It is *not* a Metabase admin tool. Creating dashboards, editing cards, configuri

Metabase API keys (v0.49+) inherit the *permissions of the group they're bound to*. The MCP sends the resolved key in the `X-API-Key` header on every upstream request.

There is no per-user delegation: one API key per MCP instance, applied to every tool call. To give different agents different access, mount multiple MCP instances bound to different Metabase groups.
The Metabase MCP uses one API key per MCP instance, applied to every tool call, with no per-user delegation. To give different agents different access, mount multiple MCP instances bound to different Metabase groups.

Auth is implemented as `oneof auth { StaticKeyAuth api_key }` (single variant today, future-proof for adding session or OAuth modes without a wire-format break).

Expand Down
2 changes: 1 addition & 1 deletion modules/observability/pages/ingest-custom-traces.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you're using LangChain with OpenTelemetry tracing, you can send traces to Red

. Configure LangChain's OpenTelemetry integration by following the https://docs.langchain.com/langsmith/trace-with-opentelemetry[LangChain documentation^].

. Deploy a Redpanda Connect pipeline using the `otlp_http` input to receive OTLP traces over HTTP. Today, create the pipeline in the **Connect** page of your Redpanda BYOC environment. See the <<configure-the-ingestion-pipeline,Configure the ingestion pipeline>> section below for a sample configuration.
. Deploy a Redpanda Connect pipeline using the `otlp_http` input to receive OTLP traces over HTTP. Today, create the pipeline in the **Connect** page of your Redpanda BYOC environment. For a sample configuration, see <<configure-the-ingestion-pipeline,Configure the ingestion pipeline>>.
// TODO: Update the deployment entry point once the standalone-ADP ingestion flow is defined.

. Configure your OTEL exporter to send traces to your Redpanda Connect pipeline using environment variables:
Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
"build": "antora --to-dir docs --fetch local-antora-playbook.yml",
"serve": "wds --node-resolve --open / --watch --root-dir docs --port 5002",
"start": "cross-env-shell LIVERELOAD=true npx gulp",
"test-quickstart": "cd tests/setup-tests && npx doc-detective --input ../../modules/get-started/pages/quick-start.adoc -l debug",
"test-console-auth": "cd tests/setup-tests && npx doc-detective --input ../../modules/console/pages/config/security/authentication.adoc -l debug",
"test-quickstart": "cd tests/setup-tests && npx doc-detective --input ../../modules/get-started/pages/byoc-quickstart.adoc -l debug",
"test-docs": "cd tests/setup-tests && npx doc-detective --input ../../modules -l debug"
},
"dependencies": {
Expand Down