-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-2043 Document AI gateway cloud secret store integration #520
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 6 commits
8c5ec71
12b7fd5
ed1b549
2b8f891
bba00ae
1cc2dd2
a536c61
2f3d7d3
f6de51f
598e819
33b4254
3a79d7d
590fc19
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| = AI Gateway Secret Management | ||
| :description: Understand 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]. Unlike Redpanda Connect or MCP Server secrets, which you create manually, AI Gateway secrets are created and managed for you. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
|
|
||
| == 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. | ||
| * These secrets are labeled `managed-by:aigateway` in the Secrets Store. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
| * Secrets are backed by the secret store used by the Redpanda Cloud data plane and never leave the data plane. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
| * At runtime, the AI Gateway reads provider credentials directly from the Secrets Store. | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| 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. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
| -- | ||
| + | ||
| The *ID* field (the secret identifier) cannot be changed. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
|
|
||
| . Click *Save*. | ||
|
|
||
| == Rotate provider API keys | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
|
|
||
| When you rotate a provider API key through the provider's *Configuration* tab, the corresponding Secrets Store entry is automatically updated. | ||
|
|
||
| To rotate credentials without downtime: | ||
|
|
||
| . Navigate to *Agentic* → *AI Gateway* → *Providers*, select the provider, and click *Configuration*. | ||
| . Click *Add Configuration* to add a new API key (don't remove the old one yet). | ||
| . Wait for the new key to propagate (approximately 5 minutes). | ||
| . Verify the new key works by sending a test request through the gateway. | ||
| . Remove the old API key. | ||
|
|
||
| Each provider configuration supports multiple API keys. AI Gateway automatically load-balances across them, which allows zero-downtime rotation. For more details, see the credential rotation steps in xref:ai-gateway/admin/setup-guide.adoc[]. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
|
|
||
| For an overview of all secret scopes in Redpanda Cloud, see xref:security:secrets.adoc[]. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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[]. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 🤔
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
|
||
|
|
@@ -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 | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.