Skip to content
Open
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
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
*** xref:ai-agents:ai-gateway/gateway-architecture.adoc[Architecture]
*** For Administrators
**** xref:ai-agents:ai-gateway/admin/setup-guide.adoc[Setup Guide]
**** xref:ai-agents:ai-gateway/admin/secret-management.adoc[Secret Management]
*** For Builders
**** xref:ai-agents:ai-gateway/builders/discover-gateways.adoc[Discover Gateways]
**** xref:ai-agents:ai-gateway/builders/connect-your-agent.adoc[Connect Your Agent]
Expand Down
50 changes: 50 additions & 0 deletions modules/ai-agents/pages/ai-gateway/admin/secret-management.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
= AI Gateway Secret Management
:description: Describes how AI Gateway stores provider API keys in the Secrets Store and how to view, rotate, and manage them.
:page-topic-type: how-to
:personas: platform_admin
:learning-objective-1: Understand how AI Gateway secrets are stored in the Secrets Store
:learning-objective-2: View AI Gateway secrets in the Secrets Store UI
:learning-objective-3: Rotate provider API keys

include::ai-agents:partial$adp-la.adoc[]

When you add a provider API key through the AI Gateway configuration UI, the key is automatically stored in the xref:security:secrets.adoc[Secrets Store].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When and why would you need to use this--what is the benefit? Need a brief "benefit of using this" statement.


== How AI Gateway secrets work

AI Gateway integrates with the Secrets Store to manage provider API keys securely:

* When you add an API key to an LLM provider (through *AI Gateway* → *Providers* → select a provider → *Configuration* → *Add Configuration*), AI Gateway automatically creates a corresponding secret in the Secrets Store.
* Secrets are backed by the Secrets Store used by the Redpanda Cloud data plane and never leave the data plane.
* At runtime, the AI Gateway reads provider credentials directly from the Secrets Store.

You can also edit AI Gateway secrets directly in the Secrets Store. The secret ID cannot be changed, but you can update the secret value, scopes, and tags.

TIP: To create or delete provider API keys, use the AI Gateway provider configuration UI (*Agentic* → *AI Gateway* → *Providers* → select a provider → *Configuration*). To update an existing secret's value, scopes, or tags, go to the Secrets Store.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any prereqs or limitations?

== View AI Gateway secrets

To see the secrets that AI Gateway has created:

. In the Redpanda Cloud Console, open the *Secrets Store*.
. Look for secrets with the *AI Gateway* scope label.
+
These secrets are labeled `managed-by:aigateway` to distinguish them from secrets created manually for other services.

== Edit AI Gateway secrets

You can edit an AI Gateway secret directly in the Secrets Store:

. Open the *Secrets Store*.
. Select the secret you want to update.
. Update any of the following fields:
+
--
* *Value*: The API key value. Leave empty to keep the existing value.
* *Scopes*: The resources that can access this secret.
* *Tags*: Key-value pairs for organizing and categorizing secrets.
--
+
You cannot edit the *ID* field (the secret identifier).

. Click *Save*.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Providers represent upstream services (Anthropic, OpenAI, Google AI) and associa
. On the Configuration tab for the provider, click *Add configuration*.
. Enter your API Key for the provider.
+
TIP: Store provider API keys securely. Each provider configuration can have multiple API keys for rotation and redundancy.
NOTE: Provider API keys are automatically stored in the xref:security:secrets.adoc[Secrets Store] when you save the configuration. Each provider configuration supports multiple API keys for rotation and redundancy. For details, see xref:ai-gateway/admin/secret-management.adoc[].

. Click *Save* to enable the provider.

Expand Down
4 changes: 2 additions & 2 deletions modules/ai-agents/partials/ai-hub/configure-ai-hub.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ curl https://api.redpanda.com/v1/gateways/${GATEWAY_ID}/ai-hub/preferences \

== Manage provider credentials

AI Hub gateways require provider credentials to route requests. Credentials are stored encrypted and shared across all gateways in your workspace.
AI Hub gateways require provider credentials to route requests. Credentials are automatically stored in the xref:security:secrets.adoc[Secrets Store] and shared across all gateways in your workspace. For details on how AI Gateway manages secrets, see xref:ai-agents:ai-gateway/admin/secret-management.adoc[].

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh wow, what is this? AI hub does not even exists right now 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Hub content is a WIP, initial stuff from Camilo when we thought it might make it in Package 1. It's in a partial: none of the files in the partials folder render in our docs.


=== Add OpenAI credentials

Expand Down Expand Up @@ -265,7 +265,7 @@ To rotate credentials without downtime:
. Test with a sample request to verify the new key works.
. Delete the old API key.

AI Gateway automatically load-balances across multiple API keys if you configure more than one per provider.
When you rotate credentials, the corresponding entry in the Secrets Store is automatically updated. AI Gateway automatically load-balances across multiple API keys if you configure more than one per provider.

=== Verify credentials

Expand Down
3 changes: 1 addition & 2 deletions modules/security/pages/secrets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Redpanda Cloud also uses _static secrets_, stored in either the
https://aws.amazon.com/secrets-manager/[AWS Secrets Manager^] or
https://cloud.google.com/secret-manager[GCP Secret Manager^] services. Static
secrets managed through Redpanda Console never leave their corresponding
data plane account or network. They stay securely stored in AWS Secrets Manager or
GCP Secret Manager.
data plane account or network. They stay securely stored in AWS Secrets Manager or GCP Secret Manager.