DOCS-418 & 729: Document SRA session recording and tunnel limitations with web-access recording guide#228
Open
harrison-akeyless wants to merge 20 commits into
Open
DOCS-418 & 729: Document SRA session recording and tunnel limitations with web-access recording guide#228harrison-akeyless wants to merge 20 commits into
harrison-akeyless wants to merge 20 commits into
Conversation
…d secretless access (DOCS-418)
|
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)
📝 WalkthroughWalkthroughThis PR updates SRA docs to clarify tunnel audit wording and limitations (no recording, no secretless access), adds web-access session recording docs and K8s configuration, updates RDP recording text, adjusts ordering, and adds a GCP dynamic secret location note. ChangesSecure Remote Access tunnel limitations and session recording
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 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)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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
Resolved merge conflict in sra-tunnels.md by keeping the new Limitations section that documents session recording and secretless access restrictions for SRA tunnels.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/Secure Remote Access/index.md (1)
46-46: ⚡ Quick winConsider consistent formatting for permission names.
The content addition is excellent and clarifies an important distinction. However, there's a minor formatting inconsistency: this file uses Read (italic) while
sra-tunnels.mdline 28 andsra-desktop-application-beta.mdline 35 useRead(inline code) for the same permission name. Consider using inline code formatting consistently across all three files.Suggested formatting alignment
-6. Granular RBAC: Access can be tightly scoped so that each user is granted only the necessary permissions to the specific targets or resources they need (Users are restricted from accessing anything beyond their defined scope). For portal-based connections, users only need SRA permissions to initiate connections—without requiring any _Read_ access to the underlying secrets. **Note:** Secretless access does not apply to tunnel-based connections; those connections require explicit _Read_ permission on the secret item. +6. Granular RBAC: Access can be tightly scoped so that each user is granted only the necessary permissions to the specific targets or resources they need (Users are restricted from accessing anything beyond their defined scope). For portal-based connections, users only need SRA permissions to initiate connections—without requiring any `Read` access to the underlying secrets. **Note:** Secretless access does not apply to tunnel-based connections; those connections require explicit `Read` permission on the secret item.🤖 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/index.md at line 46, The permission name formatting is inconsistent: change the italicized _Read_ in the added line to inline code formatting `Read` so it matches the other docs that use `Read` (the permission token), i.e., locate the string "Read" in the new sentence about native SSO integrations and replace the markdown italic with inline-code backticks to keep permission-name formatting consistent across the docs.
🤖 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.
Nitpick comments:
In `@docs/Secure` Remote Access/index.md:
- Line 46: The permission name formatting is inconsistent: change the italicized
_Read_ in the added line to inline code formatting `Read` so it matches the
other docs that use `Read` (the permission token), i.e., locate the string
"Read" in the new sentence about native SSO integrations and replace the
markdown italic with inline-code backticks to keep permission-name formatting
consistent across the docs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9202003c-d65a-4980-95c1-63f61b491b80
📒 Files selected for processing (3)
docs/Secure Remote Access/index.mddocs/Secure Remote Access/sra-admin-guides/sra-resource-types/sra-tunnels.mddocs/Secure Remote Access/sra-user-guides/sra-desktop-application-beta.md
harrison-akeyless
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/Secure` Remote
Access/sra-admin-guides/sra-session-management/sra-rdp-recordings.md:
- Line 41: Update the hyphenation in the sentence under the "Algorithm" bullet:
replace the phrase "Akeyless supported key types" with "Akeyless-supported key
types" so the line reads "* **Algorithm:** Encryption uses Akeyless-supported
key types." Locate the bullet with the "**Algorithm:**" label in
sra-rdp-recordings.md and make this single-word hyphenation change.
🪄 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: ed744143-89a7-43dd-bd9d-132f356e261c
📒 Files selected for processing (4)
docs/Secrets Management/how-to-create-dynamic-secret/gcp-dynamic-secrets.mddocs/Secure Remote Access/sra-admin-guides/sra-session-management/index.mddocs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-rdp-recordings.mddocs/Secure Remote Access/sra-setup/sra-web-access-on-k8s/index.md
✅ Files skipped from review due to trivial changes (2)
- docs/Secrets Management/how-to-create-dynamic-secret/gcp-dynamic-secrets.md
- docs/Secure Remote Access/sra-setup/sra-web-access-on-k8s/index.md
harrison-akeyless
force-pushed
the
v1.0_docs-418-sra-tunnel-limitations
branch
from
90db5d7 to
8ae1b55
Compare
harrison-akeyless
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-rdp-recordings.md (1)
45-45:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winHyphenate the compound modifier in the algorithm bullet.
Use “Akeyless-supported key types” for correct grammar and readability.
🤖 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-admin-guides/sra-session-management/sra-rdp-recordings.md at line 45, Update the Algorithm bullet so the compound modifier is hyphenated: change the phrase "Akeyless supported key types" to "Akeyless-supported key types" in the line beginning with "**Algorithm:**" to improve grammar and readability.
🤖 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/Secure` Remote
Access/sra-admin-guides/sra-session-management/sra-rdp-recordings.md:
- Around line 113-119: The "## Related Pages" heading is placed before the
storage subsections causing "### Azure Blob Storage" to be interpreted as its
child; move the "## Related Pages" block to the end of the document (after the
storage subsections) or alternatively demote it to "### Related Pages" so that
"### Azure Blob Storage" remains a child of "## Storage Options"; update the
headings around "## Storage Options", "### Azure Blob Storage" and "## Related
Pages" accordingly to restore proper hierarchy.
---
Duplicate comments:
In `@docs/Secure` Remote
Access/sra-admin-guides/sra-session-management/sra-rdp-recordings.md:
- Line 45: Update the Algorithm bullet so the compound modifier is hyphenated:
change the phrase "Akeyless supported key types" to "Akeyless-supported key
types" in the line beginning with "**Algorithm:**" to improve grammar and
readability.
🪄 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: 8a0193f6-d4cb-461e-baf1-a0f7b65df33a
📒 Files selected for processing (5)
docs/Secure Remote Access/sra-admin-guides/sra-session-management/_order.yamldocs/Secure Remote Access/sra-admin-guides/sra-session-management/index.mddocs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-rdp-recordings.mddocs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-web-access-session-recording.mddocs/Secure Remote Access/sra-setup/sra-web-access-on-k8s/index.md
✅ Files skipped from review due to trivial changes (3)
- docs/Secure Remote Access/sra-admin-guides/sra-session-management/_order.yaml
- docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-web-access-session-recording.md
- docs/Secure Remote Access/sra-admin-guides/sra-session-management/index.md
…ve Related Pages to end
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
1 participant
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.
Summary
Integrates DOCS-729 Zero Trust Portal v1.12.6 and ZTWA v2.0.0-rc2 release updates into product documentation and documents known SRA tunnel limitations for session recording and secretless access.
Changes
DOCS-418: SRA Tunnel Limitations
DOCS-729: Session Recording and Release Updates
Consolidated RDP Session Recording: Merged two RDP recording pages into canonical
sra-rdp-recordings.mdwith complete reference documentation including:Dedicated Web Access Session Recording Guide: Created
sra-web-access-session-recording.mdwith comprehensive ZTWA recording documentation:Updated Session Management Overview: Clarified distinction between RDP and web-access session recording types with cross-references to canonical documentation pages
GCP Dynamic Secrets Placement: Added guidance for configuring GCP dynamic secret locations in ZTWA deployments
ZTWA Setup Documentation: Enhanced with complete session recording configuration surface documentation
Motivation
Customers needed clear documentation distinguishing between two different session recording implementations (RDP recording managed through Gateway CLI vs. ZTWA recording managed through Helm chart values). Additionally, tunnel limitations documentation prevents support escalations from users attempting unsupported feature combinations.
Resolves DOCS-418 and DOCS-729
Related Issues