Skip to content

[New article]: Aspire Resource Model: Concepts, Design, and Authoring Guidance #3159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidfowl opened this issue Apr 27, 2025 · 3 comments
Labels
area-docs doc-idea Indicates issues that are suggestions for new topics [org][type][category] Pri1 High priority, do before Pri2 and Pri3

Comments

@davidfowl
Copy link
Member

Proposed topic or title

Aspire Resource Model: Concepts, Design, and Authoring Guidance

Location in table of contents.

fundamentals/resource-model

Reason for the article

Developers, integrators, and contributors building on Aspire need a deep understanding of the resource model that underpins distributed application development.
Without a clear mental model, it's easy to misuse Aspire's APIs, flatten structured values too early, or create brittle application graphs.
This article would fill a major gap by explaining Aspire’s fundamental concepts — resources, annotations, structured values, references, endpoint allocation — in one cohesive guide.
It would prevent architectural mistakes and enable a wider audience to author custom resources, publishers, and tooling with confidence.

Article abstract

This article explains the Aspire Resource Model in depth, covering how distributed applications are expressed as graphs of inert resources, how metadata is layered through annotations, how structured references and values enable safe deferred evaluation, and how lifecycle orchestration works.
Readers will learn how to properly model services, extend Aspire with custom resource types, manage dependencies, and author value providers and publishers that integrate cleanly with the Aspire ecosystem.

Relevant searches

No response

@davidfowl davidfowl added area-docs doc-idea Indicates issues that are suggestions for new topics [org][type][category] Pri1 High priority, do before Pri2 and Pri3 labels Apr 27, 2025
@davidfowl
Copy link
Member Author

@IEvangelist I wrote this gist https://gist.github.com/davidfowl/b408af870d4b5b54a28bf18bffa127e1

I don't know if it should be a single doc, but it has all of the right content I think (I did lots of brain dumping and rewriting). It also contains #2340 so we can scrap that one.

@davidfowl
Copy link
Member Author

cc @mitchdenny @eerhardt @captainsafia @aaronpowell @Alirexaa would love to get your feedback (and any other community toolkit members that have been building integrations).

@IEvangelist
Copy link
Member

Please see #3156 which might address at least some of this work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-docs doc-idea Indicates issues that are suggestions for new topics [org][type][category] Pri1 High priority, do before Pri2 and Pri3
Projects
None yet
Development

No branches or pull requests

2 participants