DOCS-826: expand SRA requirements for session affinity, cookies, and LB timeouts#281
DOCS-826: expand SRA requirements for session affinity, cookies, and LB timeouts#281harrison-akeyless wants to merge 6 commits into
Conversation
|
Warning Review limit reached
More reviews will be available in 41 minutes and 38 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR expands and reorganizes the SRA requirements documentation by adding a comprehensive Requirements Checklist and Core Infrastructure Requirements section, followed by new detailed sections covering session routing, cookie affinity, timeout alignment, redirect URL allowlisting, and session-recording authentication compatibility. ChangesSRA Requirements Documentation Expansion
Estimated Code Review Effort🎯 2 (Simple) | ⏱️ ~8 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 |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/Secure Remote Access/sra-setup/sra-requirements.md (1)
13-13:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winDefine acronyms on first use.
The acronyms "SRA" and "ZTWA" are used without definition. As per coding guidelines, define non-obvious acronyms on first use in documentation.
📝 Proposed fix
-Use this page to validate infrastructure requirements before deploying Akeyless Gateway with Secure Remote Access (SRA) and Zero Trust Web Access (ZTWA). +Use this page to validate infrastructure requirements before deploying Akeyless Gateway with Secure Remote Access (SRA) and Zero Trust Web Access (ZTWA) capabilities.Or more explicitly:
-Use this page to validate infrastructure requirements before deploying Akeyless Gateway with Secure Remote Access (SRA) and Zero Trust Web Access (ZTWA). +Use this page to validate infrastructure requirements before deploying Akeyless Gateway with Secure Remote Access (SRA) and Zero Trust Web Access (ZTWA). SRA provides secure access to remote systems, while ZTWA enables browser-based access with zero trust controls.As per coding guidelines: "Define non-obvious acronyms on first use in documentation"
🤖 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 `@docs/Secure` Remote Access/sra-setup/sra-requirements.md at line 13, The acronyms "SRA" and "ZTWA" are used without definition in the sentence "Use this page to validate infrastructure requirements before deploying Akeyless Gateway with Secure Remote Access (SRA) and Zero Trust Web Access (ZTWA)"; update that first occurrence to include each acronym's full form in parentheses (e.g., "Secure Remote Access (SRA)" and "Zero Trust Web Access (ZTWA)") so both acronyms are defined on first use and subsequent instances can use the short forms.
🤖 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.
Outside diff comments:
In `@docs/Secure` Remote Access/sra-setup/sra-requirements.md:
- Line 13: The acronyms "SRA" and "ZTWA" are used without definition in the
sentence "Use this page to validate infrastructure requirements before deploying
Akeyless Gateway with Secure Remote Access (SRA) and Zero Trust Web Access
(ZTWA)"; update that first occurrence to include each acronym's full form in
parentheses (e.g., "Secure Remote Access (SRA)" and "Zero Trust Web Access
(ZTWA)") so both acronyms are defined on first use and subsequent instances can
use the short forms.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5f17bf36-08be-410f-8d9e-76e445b488a5
📒 Files selected for processing (1)
docs/Secure Remote Access/sra-setup/sra-requirements.md
…y for session handling and timeout policies
Summary
Validation
Summary by CodeRabbit