chore: Update authz overview to clarify RBAC concepts#546
chore: Update authz overview to clarify RBAC concepts#546LakshanSS merged 2 commits intoopenchoreo:mainfrom
Conversation
Signed-off-by: binoyPeries <binoyperies98@gmail.com>
📝 WalkthroughSummary by CodeRabbit
WalkthroughDocumentation updated to generalize RBAC framing to OpenChoreo, add user-facing permission use-cases, and explain RBAC mechanics including subjects, roles, scopes, and binding evaluation with an Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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.
🧹 Nitpick comments (1)
docs/platform-engineer-guide/authorization/overview.md (1)
105-105: Optional: Minor style suggestion.The static analysis tool suggests removing "of" for conciseness ("all the following" instead of "all of the following"). Both forms are correct; the current phrasing is perfectly acceptable and commonly used in documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/platform-engineer-guide/authorization/overview.md` at line 105, Edit the sentence that currently reads "When a request arrives, OpenChoreo evaluates it against every role binding the subject matches. For each binding, all of the following must hold for the binding to apply:" and remove the word "of" so it reads "...all the following must hold for the binding to apply:"; update the line in the Authorization overview section (the sentence beginning "When a request arrives...") to use the more concise phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/platform-engineer-guide/authorization/overview.md`:
- Line 105: Edit the sentence that currently reads "When a request arrives,
OpenChoreo evaluates it against every role binding the subject matches. For each
binding, all of the following must hold for the binding to apply:" and remove
the word "of" so it reads "...all the following must hold for the binding to
apply:"; update the line in the Authorization overview section (the sentence
beginning "When a request arrives...") to use the more concise phrasing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: da03d23b-a6e5-473b-a81f-efeb27294454
⛔ Files ignored due to path filters (1)
versioned_docs/version-v1.0.x/platform-engineer-guide/authorization/overview.mdis excluded by!versioned_docs/**
📒 Files selected for processing (1)
docs/platform-engineer-guide/authorization/overview.md
Signed-off-by: binoyPeries <binoyperies98@gmail.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/platform-engineer-guide/authorization/overview.md (1)
101-102: Consider adding a YAML snippet showing theeffectfield.The text clearly explains the
effectfield, but a small YAML example showingeffect: denyin context could help users visualize how to use it. For instance:apiVersion: platform.openchoreo.io/v1alpha1 kind: AuthzRoleBinding metadata: name: deny-secret-project spec: subject: groups:developers roleMappings: - roleRef: name: developer effect: deny # <-- explicit denial scope: namespace: acme project: secretThis is optional since the API reference likely has full examples, but it could improve readability here.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/platform-engineer-guide/authorization/overview.md` around lines 101 - 102, Add a short YAML example demonstrating the effect field (showing effect: deny) near the paragraph that explains it; include an AuthzRoleBinding example that references roleMappings → roleRef (e.g., name: developer), subject (e.g., groups:developers) and a scope (namespace/project) so readers can see effect: deny in context and understand it revokes access from that role binding.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/platform-engineer-guide/authorization/overview.md`:
- Around line 101-102: Add a short YAML example demonstrating the effect field
(showing effect: deny) near the paragraph that explains it; include an
AuthzRoleBinding example that references roleMappings → roleRef (e.g., name:
developer), subject (e.g., groups:developers) and a scope (namespace/project) so
readers can see effect: deny in context and understand it revokes access from
that role binding.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8b017185-efb2-4695-91e6-019b49330fad
⛔ Files ignored due to path filters (1)
versioned_docs/version-v1.0.x/platform-engineer-guide/authorization/overview.mdis excluded by!versioned_docs/**
📒 Files selected for processing (1)
docs/platform-engineer-guide/authorization/overview.md
Purpose
Summary
"Hierarchical RBAC" collides with the NIST/INCITS 359 term, which means role-to-role inheritance. OpenChoreo roles are flat;
the hierarchy is over resources, not roles. This PR drops the label, restructures the authz overview, and documents the
effect: allow | deny rule that was previously missing from the overview.
Changes
Applied to both docs/platform-engineer-guide/authorization/overview.md and
versioned_docs/version-v1.0.x/platform-engineer-guide/authorization/overview.md:
name.
deny-overrides-allow rule.
Related Issues
Refer discussion: openchoreo/openchoreo#2958 (comment)
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors