feat(operator): Kong Operator AI Gateway Docs #6004
Open
cloudjumpercat wants to merge 1 commit into
Open
Conversation
* feat(operator): AI Gateway docs — KonnectAIGateway rename + IdentityProvider Two breaking CRD changes from KO 2.2 (July 10): - AIGatewayControlPlane renamed to KonnectAIGateway (commit e1a708c) - New AIGatewayIdentityProvider CRD (key-auth / openid-connect) added (commit e5c22cc) Docs updated: - 4-step getting started series: install, deploy, policies, consumers - Consumers step now creates AIGatewayIdentityProvider before consumers - Reference page: resource model table, reference chain, new IdentityProvider section - Series, index, and landing page wiring - QA test plan: new Section 7 (Identity Providers), all KonnectAIGateway rename fixes - Fix broken related_resources link in support doc (rate-limiting/examples → rate-limiting) CRD corrections carried forward from prior audit: - AIGatewayModelProvider (was AIGatewayProvider) - Auth uses SensitiveDataSource (secretRef), aiGatewayRef throughout - AIGatewayConsumerCredential: aiGatewayConsumerRef + apiKey.secretRef - AIGatewayDataPlane auto-provisions mTLS cert Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * feat(operator): AI Gateway getting started series and reference docs * fix vale issues * fix codex feedback * Apply suggestions from code review pt 1 Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Fix build failure Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * tech preview badges, remove qa file Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces Kong Operator documentation for deploying and managing AI Gateway on Konnect-managed Kubernetes clusters, including a new “Get Started” series and a Konnect/Operator reference page, plus associated navigation updates.
Changes:
- Adds a new Operator “Get Started” series for AI Gateway (install → deploy → policy → consumers).
- Adds an Operator Konnect reference page describing the AI Gateway CRD resource model and relationships.
- Updates Operator landing/index navigation and makes a small support doc related-resource link adjustment.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| app/operator/konnect/ai-gateway.md | Adds a reference page for Operator-managed AI Gateway CRDs and their relationships. |
| app/_support/how-to-configure-consumer-groups-rate-limiting-policy-after-upgrading-to-latest-kong-version.md | Updates a related resource link for the Rate Limiting plugin. |
| app/_landing_pages/operator.yaml | Adds an AI Gateway “Deploy on Kubernetes” card to the Operator landing page. |
| app/_indices/operator.yaml | Adds AI Gateway getting-started paths and the new Konnect reference page to the Operator index. |
| app/_how-tos/operator/operator-get-started-ai-gateway-1-install.md | Adds series step 1: install Operator with AI Gateway controller enabled and verify CRDs. |
| app/_how-tos/operator/operator-get-started-ai-gateway-2-deploy.md | Adds series step 2: create KonnectAIGateway, provider/model resources, and deploy the dataplane. |
| app/_how-tos/operator/operator-get-started-ai-gateway-3-policy.md | Adds series step 3: create and validate an AIGatewayPolicy (prompt guard example). |
| app/_how-tos/operator/operator-get-started-ai-gateway-4-consumers.md | Adds series step 4: configure identity provider + AI Consumers + credentials + groups and test auth. |
| app/_data/series.yml | Registers the new operator-get-started-ai-gateway series entry for site navigation. |
Comment on lines
+97
to
+102
| ```bash | ||
| kubectl create secret generic openai-credentials \ | ||
| --from-literal=token="Bearer ${OPENAI_API_KEY}" \ | ||
| -n kong | ||
| kubectl label secret openai-credentials konghq.com/secret=true -n kong | ||
| ``` |
Comment on lines
+128
to
+133
| curl -s http://$AIGW_HOST:8000/v1/chat/completions \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "model": "gpt-4o-mini", | ||
| "messages": [{"role": "user", "content": "How do I configure a Kubernetes namespace?"}] | ||
| }' | jq .choices[0].message.content |
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
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.
Description
Original PR: #5922
Was reverted from the AIGW 2.0 release branch so it could go into the KO 2.3 branch instead. I rebuilt this from the original PR's merge commit since the separate commits that were in the original PR wouldn't cherry-pick.
Preview Links
Checklist
descriptionentry in frontmatter.