docs: rewrite the custom resources guide for the reconcile flow - #1872
docs: rewrite the custom resources guide for the reconcile flow#1872rohilsurana wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe custom-resource authorization guide now documents declarative registration through ChangesCustom-resource authorization documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
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 |
Coverage Report for CI Build 31482211217Coverage remained the same at 48.082%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
|
@coderabbitai review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 0213da99-fd48-4378-92cc-253bcb9a9ad1
📒 Files selected for processing (1)
docs/content/docs/authz/custom-resources.mdx
rohilsurana
left a comment
There was a problem hiding this comment.
Automated code review (xhigh) of the docs rewrite. Findings below, most important first. The first two are worth fixing before merge: the main example and the "omitting permissions" note both describe reconcile as adding/keeping permissions when it actually replaces the whole set, so a reader following them would strip permissions from built-in roles.
…er to the quick reference
…the custom resources guide
What
Rewrites the "Custom Resources and Permissions" guide to match the new model. The boot-time
resources_config_pathloader is gone (removed in #1767), so custom permissions and roles are registered through thefrontier reconcileflow or the admin API now, not a config file read at startup.Changes:
Permission/Roledocument format, thefrontier reconcileandfrontier exportcommands, and the reconcile rules (identity-only permissions, delete needsdelete: true,app/...namespaces rejected).AppendSchemaregenerates the schema (base schema plus every permission in the database) and writes to Postgres and SpiceDB, and the same step runs at boot.user/projectproxy section:app/...namespaces are now rejected with an error by both reconcile and the admin API, instead of being silently ignored from a config file.kind: Roledocuments and the reconcile role semantics: a listed field is the whole desired value (so listingpermissionsreplaces the set), while an omitted field keeps the role's default.Why
The old guide described the removed boot-time config-file loader end to end. #1767 added a short banner as a stopgap; this replaces the banner with a full rewrite.
Stacked on #1767
This is stacked on
chore/remove-resources-config-path-flow(#1767), because the guide describes the world after that PR removes the loader. Retarget tomainonce #1767 merges.