Skip to content

[Docs] Document connection/credential access control in environments - #1206

Merged
leecalcote merged 1 commit into
masterfrom
docs/connection-credential-access-control
Aug 13, 2026
Merged

[Docs] Document connection/credential access control in environments#1206
leecalcote merged 1 commit into
masterfrom
docs/connection-credential-access-control

Conversation

@leecalcote

@leecalcote leecalcote commented Aug 13, 2026

Copy link
Copy Markdown
Member

Notes for Reviewers

Supersedes and closes #1141.

Description

Adds an Access Control for Connections and Credentials section to cloud/concepts/spaces/environments.md, documenting the same topic #1141 set out to cover, but verified directly against the meshery-cloud implementation (server/dao/connection_access.go) rather than written from assumption. Differences from #1141:

Verified locally: npm install && hugo --gc builds cleanly (1604 pages, no broken {{< ref >}} links) and the new section's heading anchor and TOC entry render as expected.

Signed commits

  • Yes, I signed my commits.

Summary by CodeRabbit

  • Documentation
    • Added guidance on access control for connections and credentials.
    • Clarified direct ownership, workspace/team read-only access, and the “View All Organizations” key bypass.
    • Documented that Designs and Views use separate access mappings.

Supersedes PR #1141. Verified the three access paths against the
meshery-cloud implementation (server/dao/connection_access.go) rather
than documenting them from the PR description alone:

- Direct ownership and Workspace/Team indirect access are both real,
  but indirect access is read-only - it does not confer delete/modify
  rights, which the original PR did not distinguish.
- Adds the "View All Organizations" key override, a third access path
  that exists in code but was missing from the original PR.
- Drops the original PR's claim that Designs and Views inherit access
  through the same Workspace/Team chain - they use a separate
  resource-access-mapping mechanism instead.

Leaves identity-and-security/_index.md untouched; the original PR's
edit there swapped an em-dash for parentheses, which its own review
flagged as an inconsistency, not an improvement.

Signed-off-by: miacycle <184569369+miacycle@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: fcd24240-2f76-4730-817f-a144809cd3a2

📥 Commits

Reviewing files that changed from the base of the PR and between 13748b9 and 1df36b9.

📒 Files selected for processing (1)
  • content/en/cloud/concepts/spaces/environments.md

📝 Walkthrough

Walkthrough

The environment documentation now explains access control for Connections and Credentials through ownership, Workspace or Team membership, and the “View All Organizations” key. It also distinguishes access mappings for Designs and Views.

Changes

Environment access control

Layer / File(s) Summary
Document connection and credential access
content/en/cloud/concepts/spaces/environments.md
Adds access rules for direct ownership, Workspace or Team membership, and the “View All Organizations” key. Documents read/write and read-only permissions, and separates Design and View access mappings.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Mergeability Score: ⚪ Minimal · up to 1df36

This documentation-only change is localized and merge-ready after normal checks and review; no actionable merge-blocking risk remains.

Suggested reviewers: codexraunak

🚥 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 title clearly identifies the documentation change for connection and credential access control.
Linked Issues check ✅ Passed The PR fulfills issue #1141 by adding the requested access-control section for connections and credentials.
Out of Scope Changes check ✅ Passed All documented changes support issue #1141 and remain within the stated documentation scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/connection-credential-access-control

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.

@leecalcote

Copy link
Copy Markdown
Member Author

Acknowledged - no actionable findings from the automated review.

@leecalcote
leecalcote merged commit 41cae29 into master Aug 13, 2026
5 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1206/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

@leecalcote
leecalcote deleted the docs/connection-credential-access-control branch August 13, 2026 03:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant