DOCS-424: Clarify ALLOWED_ACCESS_PERMISSIONS, add cache variables, and add SRA Docker Compose guidance#229
DOCS-424: Clarify ALLOWED_ACCESS_PERMISSIONS, add cache variables, and add SRA Docker Compose guidance#229harrison-akeyless wants to merge 21 commits into
Conversation
…ache var table, add SRA Docker Compose guidance (DOCS-424)
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation updates clarify Gateway access control mechanisms (GATEWAY_AUTHORIZED_ACCESS_ID vs ALLOWED_ACCESS_PERMISSIONS), expand caching configuration guidance, add environment variable details, and provide deployment-specific notes across Docker and Kubernetes setups. ChangesGateway Configuration Documentation Clarification
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
harrison-akeyless
changed the title
… as separate restriction var
…ix stale gateway.env comment
…r Redis caching Co-authored-by: Copilot <copilot@github.com>
EldadH89
left a comment
EldadH89
left a comment
There was a problem hiding this comment.
@Avi-Akeyless can you please confirm?
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@docs/Akeyless`
Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md:
- Line 212: The table cell for ALLOWED_ACCESS_PERMISSIONS uses the term "Gator
access permissions" which appears to be a typo; update the wording to "Gateway
access permissions" (or the correct product term) in the Control plane column
where the phrase "Gator access permissions" appears so it reads "Gateway access
permissions" and ensure the description for ALLOWED_ACCESS_PERMISSIONS remains
consistent with the JSON schema and example.
- Around line 202-229: The "Restrict Gateway Access" section conflicts with the
new "Restrict Gateway Callers by Access ID" content — update the older section
so it references and aligns with GATEWAY_AUTHORIZED_ACCESS_ID (mark
RESTRICT_SERVICE_TO_ACCESS_IDS as legacy/deprecated), or remove the duplicate
content and add a cross-reference to the new section; specifically edit the
section that currently documents RESTRICT_SERVICE_TO_ACCESS_IDS to instead
present GATEWAY_AUTHORIZED_ACCESS_ID as the current variable (with a deprecation
note pointing to RESTRICT_SERVICE_TO_ACCESS_IDS) and/or link to the "Restrict
Gateway Callers by Access ID" paragraph that explains allowed format and example
usage.
🪄 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: 8e965978-247c-4504-b294-a40c18bfbd21
📒 Files selected for processing (3)
docs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.mddocs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.mddocs/Secure Remote Access/sra-setup/sra-docker/index.md
✅ Files skipped from review due to trivial changes (2)
- docs/Secure Remote Access/sra-setup/sra-docker/index.md
- docs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.md
2 participants
Summary
Improves the Gateway Docker advanced configuration page with clarified env variable documentation, a cache variable reference table, and SRA Docker Compose guidance.
Changes
Motivation
Customers were confused about which env variable to use for gateway access control after legacy variable names appeared in older docs. The cache variable table and SRA Docker Compose section address gaps reported in support tickets.
Resolves DOCS-424
Summary by CodeRabbit