RFC-NNNN: [Short title of the proposal]
rfc-NNNN-short-slug.html. In the copy, update <title>, the breadcrumb,
the <h1>, and the <body> attributes data-doc (VD-RFC-NNNN),
data-page, data-status and data-updated. Delete every instruction in square
brackets and this callout. Steps and lifecycle are on the RFC Index & Process page.
This page is a template: it makes no claims about the platform.
- Status
- draft [draft | open | accepted | rejected | withdrawn | implemented]
- Author(s)
- [Name or GitHub handle]
- Owner of affected area
- [Who must approve. Use the owner from
.github/CODEOWNERS] - Opened
- [YYYY-MM-DD]
- Review deadline
- [YYYY-MM-DD]
- Decision
- [Date, decider, and link to the ADR if one results. "Pending" until then]
- Scopes touched
- [Folders or services. Link the tracking issue]
Summary
[One paragraph. What is proposed and what changes for a user or operator when it ships. A reader who stops here should still know whether this affects them.]
Motivation
[The problem, in observable terms. Include incident references, log or metric evidence, and user impact. Cite repo paths or docs for every claim about how the system works today; mark anything you have not verified as unverified.]
- [Goal 1]
- [Goal 2]
- [Explicit non-goals: what this proposal deliberately does not try to solve]
Detailed design
[Enough detail that another engineer could implement it and a reviewer could find the flaws.]
Current behaviour
[What the code or infrastructure does now, with repo-relative paths.]
Proposed behaviour
[Components, data model or schema changes (note that Flyway versions share one namespace across controlplane and tenant), API contracts, configuration, and failure modes.]
flowchart LR A[Current component] --> B[Proposed component]
Environment and configuration impact
[Which environments (production, staging, local) are affected. New env vars, secrets (names only, never values), and whether any value is baked at build time.]
Alternatives
| Option | Pros | Cons | Why not chosen |
|---|---|---|---|
| Do nothing | [ ] | [ ] | [ ] |
| [Alternative A] | [ ] | [ ] | [ ] |
Risks
| Risk | Likelihood / impact | Mitigation |
|---|---|---|
| [Security, data loss, tenant isolation, cost, latency, migration] | [ ] | [ ] |
Rollout
- [Build and test steps, and how each is verified. Keep "compiled", "tested", "deployed to staging" and "deployed to production" separate.]
- [Order of deployment across services and any migration preflight.]
- [Feature flag or default-off strategy.]
- Rollback: [How to undo it without stopping or power-cycling production.]
Open questions
- [Question, and who is expected to answer it]
Evidence & references
- [Repo-relative path or document supporting each factual claim above]