Config interpolation doc changes#356
Merged
Merged
Conversation
|
Warning Review limit reached
Next review available in: 45 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThe documentation updates standardize explicit TOML interpolation and 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/ai-gateway/next/deployment-modes/immutable-gateway.md`:
- Around line 54-65: The Kubernetes deployment example must use a config.toml
containing the immutable_gateway environment interpolation tokens, rather than
setting APIP_GW_IMMUTABLE_GATEWAY_ENABLED alone. Update the Kubernetes section
to mount or otherwise supply a tokenized config.toml with enabled and
artifacts_dir mapped to the corresponding environment variables, while
preserving the existing deployment workflow.
In `@en/docs/ai-gateway/next/deployment-modes/kubernetes/gateway-operator.md`:
- Around line 194-200: Ensure every runnable Kubernetes deployment example wires
mandatory encryption settings: in
en/docs/ai-gateway/next/deployment-modes/kubernetes/gateway-operator.md lines
194-200 and
en/docs/api-gateway/next/deployment/deployment-modes/kubernetes/gateway-operator.md
lines 266-273, add a concrete per-Gateway Helm-values ConfigMap and annotation
(or equivalent) configuring encryptionKeys.enabled and secretName; in
en/docs/api-gateway/next/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
lines 110-114, explicitly require custom-values.yaml to define those same
encryption settings.
In
`@en/docs/ai-gateway/next/deployment-modes/kubernetes/kubernetes-standalone.md`:
- Around line 61-71: Update the Kubernetes standalone deployment instructions
around “Create the Encryption Key Secret” so the target namespace is created
before the kubectl secret command runs. Include the namespace creation step in
this section or move the existing api-gateway namespace creation from the later
installation flow ahead of it, while preserving the documented -n namespace
usage.
In `@en/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.md`:
- Around line 241-251: Update the artifact-location documentation table so all
image references remain inside valid Markdown table structure instead of
appearing between rows; keep the affected rows contiguous and associate each
image through valid table-cell or explicit HTML/figure markup, including the
corresponding section around the additional referenced lines.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f4e09428-3128-4b58-8324-7ced10181ca8
⛔ Files ignored due to path filters (7)
en/docs/assets/img/ai-workspace/bottom-up/dp-origin-llm-provider-access-control.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-origin-llm-provider-template-token-mapping.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-origin-llm-proxy-deployment.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-llm-provider-template.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-llm-provider.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-llm-proxy.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-mcp-proxy.pngis excluded by!**/*.png
📒 Files selected for processing (20)
en/docs/ai-gateway/next/deployment-modes/immutable-gateway.mden/docs/ai-gateway/next/deployment-modes/kubernetes/gateway-operator.mden/docs/ai-gateway/next/deployment-modes/kubernetes/kubernetes-standalone.mden/docs/ai-gateway/next/llm-proxy/quick-start-guide.mden/docs/ai-gateway/next/mcp-proxy/quick-start-guide.mden/docs/ai-gateway/next/setup/configuration.mden/docs/api-gateway/next/deployment/deploying-apis/bottom-up-api-deployment.mden/docs/api-gateway/next/deployment/deployment-modes/immutable-gateway.mden/docs/api-gateway/next/deployment/deployment-modes/kubernetes/gateway-operator.mden/docs/api-gateway/next/deployment/deployment-modes/kubernetes/kubernetes-standalone.mden/docs/api-gateway/next/deployment/high-availability-production-deployment.mden/docs/api-gateway/next/deployment/production-deployment/security-hardening.mden/docs/api-gateway/next/quick-start-guide.mden/docs/api-gateway/next/setup/configuration.mden/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/authentication/asgardeo-setup.mden/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.mden/docs/next/ai-workspace/configuration.mden/docs/next/ai-workspace/insights.mden/mkdocs.yml
thivindu
force-pushed
the
ai-workspace-dp-cp
branch
from
July 23, 2026 03:47
a917b12 to
8e1af9a
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
en/docs/ai-gateway/next/deployment-modes/immutable-gateway.md (1)
53-65: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winKeep deployment examples consistent with tokenized configuration.
Lines [55]-[65] correctly state that direct environment variables are ignored without interpolation tokens, but later Dockerfile and Kubernetes examples still set
APIP_GW_IMMUTABLE_GATEWAY_ENABLEDdirectly. Update those examples to provide the tokenizedconfig.toml; otherwise immutable mode will not be enabled.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/docs/ai-gateway/next/deployment-modes/immutable-gateway.md` around lines 53 - 65, Update the Dockerfile and Kubernetes deployment examples in immutable-gateway.md to include a tokenized config.toml for [immutable_gateway], including the APIP_GW_IMMUTABLE_GATEWAY_ENABLED interpolation token. Remove or revise direct environment-variable-only configuration so both examples actually enable immutable mode through config interpolation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/ai-gateway/next/deployment-modes/immutable-gateway.md`:
- Around line 58-61: Update the immutable_gateway enabled configuration example
so environment interpolation preserves TOML boolean typing: use unquoted env
interpolation if config.toml supports it, or explicitly document the loader’s
string-to-boolean coercion. Keep artifacts_dir quoted because it remains a path
string.
In
`@en/docs/ai-gateway/next/deployment-modes/kubernetes/kubernetes-standalone.md`:
- Around line 66-69: Update the Kubernetes secret creation command sequence so
the temporary key file is removed only after kubectl create secret generic
gateway-encryption-keys succeeds. Chain rm to the successful command while
preserving cleanup after successful Secret creation.
In `@en/docs/api-gateway/next/deployment/deployment-modes/immutable-gateway.md`:
- Around line 57-63: Resolve the MD046 warning for the nested TOML fence in the
immutable gateway documentation by configuring the markdownlint rule for this
supported admonition pattern or restructuring the fenced block while preserving
the admonition’s rendered output and TOML syntax highlighting.
---
Duplicate comments:
In `@en/docs/ai-gateway/next/deployment-modes/immutable-gateway.md`:
- Around line 53-65: Update the Dockerfile and Kubernetes deployment examples in
immutable-gateway.md to include a tokenized config.toml for [immutable_gateway],
including the APIP_GW_IMMUTABLE_GATEWAY_ENABLED interpolation token. Remove or
revise direct environment-variable-only configuration so both examples actually
enable immutable mode through config interpolation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 261e0066-00dd-4d1f-aa4e-4aaea4aeae22
⛔ Files ignored due to path filters (7)
en/docs/assets/img/ai-workspace/bottom-up/dp-origin-llm-provider-access-control.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-origin-llm-provider-template-token-mapping.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-origin-llm-proxy-deployment.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-llm-provider-template.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-llm-provider.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-llm-proxy.pngis excluded by!**/*.pngen/docs/assets/img/ai-workspace/bottom-up/dp-to-cp-mcp-proxy.pngis excluded by!**/*.png
📒 Files selected for processing (19)
en/docs/ai-gateway/next/deployment-modes/immutable-gateway.mden/docs/ai-gateway/next/deployment-modes/kubernetes/gateway-operator.mden/docs/ai-gateway/next/deployment-modes/kubernetes/kubernetes-standalone.mden/docs/ai-gateway/next/llm-proxy/quick-start-guide.mden/docs/ai-gateway/next/mcp-proxy/quick-start-guide.mden/docs/ai-gateway/next/setup/configuration.mden/docs/api-gateway/next/deployment/deploying-apis/bottom-up-api-deployment.mden/docs/api-gateway/next/deployment/deployment-modes/immutable-gateway.mden/docs/api-gateway/next/deployment/deployment-modes/kubernetes/gateway-operator.mden/docs/api-gateway/next/deployment/deployment-modes/kubernetes/kubernetes-standalone.mden/docs/api-gateway/next/deployment/high-availability-production-deployment.mden/docs/api-gateway/next/deployment/production-deployment/security-hardening.mden/docs/api-gateway/next/quick-start-guide.mden/docs/api-gateway/next/setup/configuration.mden/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/authentication/asgardeo-setup.mden/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.mden/docs/next/ai-workspace/insights.mden/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (14)
- en/docs/next/ai-workspace/insights.md
- en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md
- en/docs/api-gateway/next/deployment/high-availability-production-deployment.md
- en/docs/api-gateway/next/deployment/production-deployment/security-hardening.md
- en/docs/api-gateway/next/quick-start-guide.md
- en/mkdocs.yml
- en/docs/api-gateway/next/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
- en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md
- en/docs/next/ai-workspace/authentication/asgardeo-setup.md
- en/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.md
- en/docs/ai-gateway/next/deployment-modes/kubernetes/gateway-operator.md
- en/docs/api-gateway/next/deployment/deployment-modes/kubernetes/gateway-operator.md
- en/docs/next/ai-workspace/ai-gateways/setting-up.md
- en/docs/api-gateway/next/deployment/deploying-apis/bottom-up-api-deployment.md
Krishanx92
approved these changes
Jul 23, 2026
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
2 participants
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.
This pull request introduces significant updates to the API Gateway documentation, focusing on clarifying configuration practices, enforcing secure deployment defaults, and updating environment variable handling. The changes emphasize that environment variables no longer override
config.tomldirectly—explicit interpolation tokens are now required. The documentation also details mandatory at-rest encryption key provisioning for Kubernetes and Docker deployments, and introduces a new reference page on configuration and environment interpolation.Related to - wso2/api-platform#2600
Configuration and Environment Variable Handling:
configuration.md) explaining how configuration is loaded, the use of interpolation tokens inconfig.toml, and the deprecation of directAPIP_GW_*environment variable overrides. The page also documents the required one-time setup process for keys and certificates.config.toml, and provided examples for adding these tokens. [1] [2] [3] [4]config.toml. [1] [2]Security and Encryption Key Provisioning:
setup.shscript, which provisions the encryption key, TLS certificates, and environment file before starting the stack. [1] [2]Bottom-up API Deployment Troubleshooting:
These changes ensure that users follow secure, explicit, and up-to-date configuration practices when deploying the API Gateway.