docs: RFC 0001 for declarative management of platform resources#1751
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe RFC documents a declarative YAML workflow for reconciling and exporting Frontier resources, defines shared kind behavior and rules for ChangesDeclarative reconciliation design
Estimated code review effort: 2 (Simple) | ~15 minutes 🚥 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 |
There was a problem hiding this comment.
Actionable comments posted: 5
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d8fb691c-6b4f-4ac9-9f5e-4c8db0d04f33
📒 Files selected for processing (1)
docs/rfcs/0001-declarative-reconcile.md
Coverage Report for CI Build 29985234895Warning Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes. Coverage increased (+0.1%) to 46.209%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions1113 previously-covered lines in 33 files lost coverage.
Coverage Stats
💛 - Coveralls |
rohilsurana
left a comment
There was a problem hiding this comment.
Verified the narrowing warning against the schema and against a live server (built from #1737, seeded an org, narrowed app_organization_owner via reconcile). One sentence in it is factually wrong; details inline. More comments on the other sections will follow.
rohilsurana
left a comment
There was a problem hiding this comment.
Follow-up comments on the remaining sections, per review discussion.
Review notes (self-review after an independent pass)Three wording fixes, all in 3ce4741:
No behavior contradictions found between the RFC and the code on the implementation branch. |
4804038 to
dea97a7
Compare
Opens the RFC with a one-screen overview: a reconcile/export flow diagram, the object-vs-value model with a decision diagram, the kinds table pulled up, and the five rules in one line each. Adds a third diagram for how one reconcile run proceeds. Object-vs-value now comes before the rules that use the term, the kinds table columns are clearer (object or value, how to remove), and a repeated intro line is cut. No change to the design itself.
Documents a declarative way to manage Frontier's platform configuration: desired-state YAML files, the
frontier reconcileandfrontier exportcommands, and the five rules every resource kind follows.The RFC now opens with an "At a glance" section (a flow diagram, the object-vs-value model with a decision diagram, the kinds table, and the five rules in one line each), so the whole model fits on one screen before the detail. This TLDR is just the lead keywords; the RFC has the full text.
TLDR
frontier reconcile -f file [--dry-run]plans, then applies;frontier export <kind>prints the live state in the same format.apiVersion: v1, akind, and aspec, checked whole before anything applies.resources_config_pathis deprecated.What it covers
resources_config_path.Status
The RFC is marked Accepted, and the flow is implemented in the
reconcilepackage and thereconcileandexportcommands. PlatformUser, Permission, Role, and Preference are merged tomain; the Webhook kind is in review (#1772). This document describes the shipped design.