Add migration analysis comparing design documents with radius codebase#1
Add migration analysis comparing design documents with radius codebase#1
Conversation
…odebase Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
migration-analysis.md
Outdated
|
|
||
| ### Suggested Target Location | ||
|
|
||
| Design documents should be migrated to the `docs/design-notes/` directory in the radius repository, preserving the current directory structure: |
There was a problem hiding this comment.
@copilot I do not want to preserve the directory structure. I don't think it is logical. can you improve the directory structure. i.e. features as a directory doesn't make sense because most the docs are related to new features.
There was a problem hiding this comment.
Redesigned the directory structure in 0db2cc8. The features/ directory is eliminated — documents are now distributed into functional-area directories that map to specific radius code paths:
radius/docs/design-notes/
├── architecture/ # System architecture, K8s integration, upgrades
├── security/ # Threat models and data protection
├── recipes/ # Recipe engine: Terraform, Bicep, registries, packs
├── resource-types/ # Core resource type designs (gateways, secrets, Dapr, etc.)
├── extensibility/ # User-defined types, resource extensibility, compute platforms
├── control-plane/ # UCP, planes APIs, cloud credentials (Azure, AWS)
├── deployment/ # Deployment controllers, GitOps, Flux
├── engineering/ # Testing, CI/CD workflows, API guidelines
└── templates/ # Design document templates
Former architecture/ threat models → security/, UDT docs → extensibility/, deployment controller → deployment/. Former cli/ and ucp/ merged into control-plane/. Each table now has a "Source" column showing where the doc currently lives in design-notes.
…preserving design-notes layout Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
Done in |
migration-analysis.md
Outdated
| | `resources/2023-10-simulated-environment.md` | Simulated Environment | `typespec/Applications.Core/environments.tsp` | | ||
| | `resources/2024-06-support-secretstores-env.md` | Secret Stores in Environment Variables | `typespec/Applications.Core/secretStores.tsp`, `pkg/corerp/frontend/controller/secretstores/` | | ||
| | `resources/2024-10-dapr-bindings.md` | Dapr Binding Implementation | `pkg/daprrp/` (Note: Dapr Bindings not yet in typespec; `pkg/daprrp/` handles Dapr resource types) | | ||
| | `resources/2025-01-gateway-timeouts.md` | Gateway Timeouts | `typespec/Applications.Core/gateways.tsp`, `pkg/corerp/renderers/gateway/` | |
There was a problem hiding this comment.
@copilot remove migration for all documents related to Applications.Core
There was a problem hiding this comment.
Removed all 15 Applications.Core documents from migration in 88def11. Any document referencing typespec/Applications.Core/ or pkg/corerp/ was moved to "Not Recommended." Updated totals: 38 recommended → 25 not recommended.
Affected sections:
- resource-types/: 9→1 (only Dapr bindings remains)
- extensibility/: 9→5 (ACI, compute extensibility, serverless removed)
- security/: 5→4 (Applications RP threat model removed)
- recipes/: 12→10 (global scope secret store, recipe packs removed)
Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
migration-analysis.md
Outdated
| | Source | Title | Would-be Directory | Reason | | ||
| |--------|-------|-------------------|--------| | ||
| | `architecture/2024-05-radius-on-dapr.md` | Radius on Dapr | `architecture/` | Proposes replacing internal service infrastructure with Dapr. No evidence this was implemented; the service architecture still uses its own patterns. | | ||
| | `architecture/2025-10-terraform-bicep-settings.md` | Terraform & Bicep Settings Lifecycle | `recipes/` | Future feature for externalizing Terraform/Bicep recipe configuration into dedicated settings resources. No corresponding settings resource types exist in `typespec/`. | |
There was a problem hiding this comment.
Moved back to recommended in 82e2db8. It's now listed under recipes/ in the "Recommended for Migration" section. Updated totals: 39 recommended, 24 not recommended.
migration-analysis.md
Outdated
| | `architecture/2025-10-terraform-bicep-settings.md` | Terraform & Bicep Settings Lifecycle | `recipes/` | Future feature for externalizing Terraform/Bicep recipe configuration into dedicated settings resources. No corresponding settings resource types exist in `typespec/`. | | ||
| | `recipe/2025-09-container.md` | Container Resource Recipe Migration | `recipes/` | Proposes replacing the imperative Go renderer for containers with a Bicep recipe. Container still uses the Go renderer chain (`pkg/corerp/renderers/container/`). | | ||
| | `features/2024-11-authz-feature-spec.md` | Authorization Feature | `control-plane/` | Granular access control and permissions for multi-tenant environments. No authorization/RBAC code exists in the radius repo. | | ||
| | `features/2025-07-10-offline-install-feature-spec.md` | Offline Installation | `engineering/` | Support for air-gapped environments. No specific offline installation code or mechanisms exist. | |
There was a problem hiding this comment.
Moved to recommended in e30a42d. Offline Installation is now listed under engineering/ in the "Recommended for Migration" section.
migration-analysis.md
Outdated
| | `features/2025-07-10-offline-install-feature-spec.md` | Offline Installation | `engineering/` | Support for air-gapped environments. No specific offline installation code or mechanisms exist. | | ||
| | `features/2025-07-23-radius-configuration-ux.md` | Configuration UX | `engineering/` | User experience design recommendations for control plane configuration. UX guidance document without direct code implementation. | | ||
| | `features/2025-07-radius-resource-types-contribution.md` | Contributing Resource Types | `engineering/` | Community contribution process and pathways document. Not a code feature specification. | | ||
| | `features/2025-08-14-terraform-bicep-settings.md` | Terraform & Bicep Settings | `recipes/` | Feature spec for externalizing settings (same future feature as architecture doc above). No corresponding settings resources in `typespec/`. | |
There was a problem hiding this comment.
Moved to recommended in e30a42d. Terraform & Bicep Settings feature spec is now listed under recipes/ alongside the architecture doc.
… migration Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
migration-analysis.md
Outdated
| | `features/2025-09-02-routes-resource-type.md` | Routes Resource Type | `resource-types/` | New routes resource type replacing legacy gateways. No `routes.tsp` or routes implementation exists; `gateways.tsp` remains the current implementation. | | ||
| | `architecture/2024-08-applications-rp-component-threat-model.md` | Applications RP Threat Model | `security/` | Related to Applications.Core (`pkg/corerp/`, `cmd/applications-rp/`) — excluded from migration. | | ||
| | `recipe/2024-01-global-scope-secret-store.md` | Global Scope Secret Store | `recipes/` | Related to Applications.Core (`pkg/corerp/frontend/controller/secretstores/`) — excluded from migration. | | ||
| | `recipe/2025-08-recipe-packs.md` | Recipe Packs | `recipes/` | Related to Applications.Core (`pkg/corerp/frontend/controller/recipepacks/`) — excluded from migration. | |
There was a problem hiding this comment.
Moved to recommended in e30a42d. Recipe Packs is now listed under recipes/ in the "Recommended for Migration" section.
migration-analysis.md
Outdated
| | `resources/2024-06-support-secretstores-env.md` | Secret Stores in Environment Variables | `resource-types/` | Related to Applications.Core (`typespec/Applications.Core/secretStores.tsp`) — excluded from migration. | | ||
| | `resources/2025-01-gateway-timeouts.md` | Gateway Timeouts | `resource-types/` | Related to Applications.Core (`typespec/Applications.Core/gateways.tsp`) — excluded from migration. | | ||
| | `features/2024-07-secretstore-feature-spec.md` | Secret Stores Extension | `resource-types/` | Related to Applications.Core (`typespec/Applications.Core/secretStores.tsp`) — excluded from migration. | | ||
| | `architecture/2025-04-aci-support.md` | ACI Integration | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`) — excluded from migration. | |
There was a problem hiding this comment.
Moved to recommended in 78b92a6. ACI Integration is now listed under extensibility/ in the "Recommended for Migration" section.
migration-analysis.md
Outdated
| | `resources/2025-01-gateway-timeouts.md` | Gateway Timeouts | `resource-types/` | Related to Applications.Core (`typespec/Applications.Core/gateways.tsp`) — excluded from migration. | | ||
| | `features/2024-07-secretstore-feature-spec.md` | Secret Stores Extension | `resource-types/` | Related to Applications.Core (`typespec/Applications.Core/secretStores.tsp`) — excluded from migration. | | ||
| | `architecture/2025-04-aci-support.md` | ACI Integration | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`) — excluded from migration. | | ||
| | `architecture/2025-04-compute-extensibility.md` | Compute Platform Extensibility | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`, `pkg/corerp/renderers/container/`) — excluded from migration. | |
There was a problem hiding this comment.
Moved to recommended in 78b92a6. Compute Platform Extensibility architecture doc is now listed under extensibility/.
migration-analysis.md
Outdated
| | `architecture/2025-04-aci-support.md` | ACI Integration | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`) — excluded from migration. | | ||
| | `architecture/2025-04-compute-extensibility.md` | Compute Platform Extensibility | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`, `pkg/corerp/renderers/container/`) — excluded from migration. | | ||
| | `features/2025-01-serverless-feature-spec.md` | Serverless Container Platforms | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`) — excluded from migration. | | ||
| | `features/2025-06-compute-extensibility-feature-spec.md` | Compute Platform Extensibility | `extensibility/` | Related to Applications.Core (`pkg/corerp/renderers/aci/`, `pkg/corerp/renderers/container/`) — excluded from migration. | |
There was a problem hiding this comment.
Moved to recommended in 78b92a6. Compute Platform Extensibility feature spec is now listed under extensibility/. Updated totals: 45 recommended, 18 not recommended.
…ks back to recommended Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
…spec) back to recommended Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
Cross-references all ~63 design documents in
nicolejms/design-notesagainst the actual codebase innicolejms/radiusto identify which documents should be migrated.Adds
migration-analysis.mdwith:pkg/dynamicrp/,typespec/UCP/resourceproviders.tsp,pkg/controller/reconciler/flux_controller.go)typespec/Applications.Core/,pkg/corerp/) excluded per project decisionradius/docs/design-notes/organized by Radius system functional area rather than preserving the original design-notes layout.specify/,.github/agents/,.vscode/)The new directory structure eliminates the catch-all
features/directory and distributes documents into purpose-driven directories that map to specific radius code paths. Most documents related to Applications.Core (typespec/Applications.Core/,pkg/corerp/) have been excluded from migration, with select documents kept per project decision (Terraform & Bicep Settings Lifecycle, Terraform & Bicep Settings feature spec, Recipe Packs, Offline Installation, ACI Integration, Compute Platform Extensibility architecture doc, and Compute Platform Extensibility feature spec):architecture/security/recipes/resource-types/extensibility/control-plane/deployment/engineering/templates/✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.