Skip to content

DOCS-424: Clarify ALLOWED_ACCESS_PERMISSIONS, add cache variables, and add SRA Docker Compose guidance#229

Open
harrison-akeyless wants to merge 16 commits into
v1.0from
v1.0_docs-424-docker-config-cleanup
Open

DOCS-424: Clarify ALLOWED_ACCESS_PERMISSIONS, add cache variables, and add SRA Docker Compose guidance#229
harrison-akeyless wants to merge 16 commits into
v1.0from
v1.0_docs-424-docker-config-cleanup

Conversation

@harrison-akeyless
Copy link
Copy Markdown
Collaborator

@harrison-akeyless harrison-akeyless commented May 5, 2026

Summary

Improves the Gateway Docker advanced configuration page with clarified env variable documentation, a cache variable reference table, and SRA Docker Compose guidance.

Changes

  • \docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md\
    • Clarified \ALLOWED_ACCESS_PERMISSIONS\ as the current standard variable for gateway admin access permissions.
    • Added a reference table for cache-related environment variables.
    • Added an SRA-specific Docker Compose configuration section.

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

Documentation

  • Updated Gateway caching configuration documentation - Clarified Docker Compose deployment setup with environment variables for cluster cache control and behavior tuning.
  • Enhanced access control documentation - Expanded guidance on configuring transport-layer and component-level access controls with updated examples.
  • Added proactive caching environment variable documentation - Documented new configuration options for caching behavior customization.
  • Clarified SRA Docker Compose deployment scope - Added note directing users to Kubernetes documentation for production setups.

…ache var table, add SRA Docker Compose guidance (DOCS-424)
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

Warning

Rate limit exceeded

@harrison-akeyless has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 35 minutes and 8 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4a58b88a-5de8-453a-9b61-8e6756985bb7

📥 Commits

Reviewing files that changed from the base of the PR and between b1f5eab and 028879a.

📒 Files selected for processing (1)
  • docs/Secure Remote Access/sra-setup/sra-docker/index.md
📝 Walkthrough

Walkthrough

Documentation 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.

Changes

Gateway Configuration Documentation Clarification

Layer / File(s) Summary
Core Access Control Documentation
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md
New "Restrict Gateway Callers by Access ID" section explains GATEWAY_AUTHORIZED_ACCESS_ID as transport-layer allowlist and ALLOWED_ACCESS_PERMISSIONS for component-level authorization; includes warning table comparing both mechanisms and examples showing current approach with legacy patterns retained.
Caching Configuration Documentation
docs/Akeyless Gateway/configure-gateway/gateway-caching/cluster-cache-standalone.md, docs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.md, docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md
Cluster cache documentation updated to clarify Docker Compose non-support and add new environment variables section (USE_CLUSTER_CACHE, GATEWAY_CLUSTER_CACHE, REDIS_ADDR, PREFER_CLUSTER_CACHE_FIRST); proactive caching documentation adds PROACTIVE_CACHE_DUMP_INTERVAL with legacy-implementation guidance; caching examples expanded with NEW_PROACTIVE_CACHE_ENABLE and related variables.
Environment Variable Reference
samples/unified-gateway/docker-compose-deploy/gateway.env
GATEWAY_AUTHORIZED_ACCESS_ID comment updated from generic description to explicit transport-layer allowlist behavior with rejection semantics.
Deployment Guidance and Cross-references
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-docker-compose.md, docs/Secure Remote Access/sra-setup/sra-docker/index.md
Docker Compose deployment documentation adds inline reference to access control warning table; SRA Docker documentation adds note clarifying subset support and linking to Kubernetes guidance for production.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

📚 Docs bloom where clarity once was thin—
Access controls mapped, cache settings clear,
Docker and Kubernetes guide the way,
A rabbit hops through notes so bright,
Configuration tales shine light! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly reflects the three main changes: clarifying ALLOWED_ACCESS_PERMISSIONS, adding cache variables, and providing SRA Docker Compose guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v1.0_docs-424-docker-config-cleanup

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@harrison-akeyless harrison-akeyless changed the title docs(docker): clarify GATEWAY_AUTHORIZED_ACCESS_ID deprecation, add cache var table, add SRA Docker Compose guidance (DOCS-424) DOCS-424: Clarify ALLOWED_ACCESS_PERMISSIONS, add cache variables, and add SRA Docker Compose guidance May 5, 2026
@harrison-akeyless harrison-akeyless marked this pull request as ready for review May 5, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant