Skip to content

Update Orleans and Aspire integration documentation #54201

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.

Sign up for GitHub

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
Meir017 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update Orleans and Aspire integration documentation #54201

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
516272c
Update Orleans and Aspire integration documentation
Meir017 Jun 7, 2026
f63361e
Apply suggestions from code review
gewarren Jul 29, 2026
8903973
Merge branch 'main' into patch-1
adegeo Aug 4, 2026
47e65ca
Apply suggestions from code review
adegeo Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/orleans/host/aspire-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ zone_pivot_groups: orleans-version

:::zone target="docs" pivot="orleans-8-0,orleans-9-0,orleans-10-0"

[Aspire](https://aspire.dev/get-started/what-is-aspire/) provides a streamlined approach to building cloud-native applications with built-in support for Orleans. Starting with Orleans 8.0, you can use Aspire to orchestrate your Orleans cluster, manage backing resources (like Redis or Azure Storage), and automatically configure service discovery, observability, and health checks.
[Aspire](https://aspire.dev/integrations/frameworks/orleans) provides a streamlined approach to building cloud-native applications with built-in support for Orleans. Starting with Orleans 8.0, you can use Aspire to orchestrate your Orleans cluster, manage backing resources (like Redis or Azure Storage), and automatically configure service discovery, observability, and health checks.
Comment thread
gewarren marked this conversation as resolved.

@gewarren gewarren Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original link makes more sense to me here.

@adegeo adegeo Aug 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that too. To me, someone is here because they probably know what aspire is and are more interested in integrating the two techs. So a link to the integration would make sense over a "what is aspire"

But I can go either way.


## Overview

Orleans integration with Aspire uses the `Aspire.Hosting.Orleans` package in your AppHost project. This package provides extension methods to:
Orleans integration with Aspire uses the [`Aspire.Hosting.Orleans` package](https://aspire.dev/integrations/frameworks/orleans/) in your AppHost project. This package provides extension methods to:

- Define Orleans as a distributed resource
- Configure clustering providers (Redis, Azure Storage, ADO.NET)
Expand All @@ -29,7 +29,11 @@ Before using Orleans with Aspire, ensure you have:

- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) or later
- [Aspire CLI](https://aspire.dev/get-started/install-cli/)
- An IDE with Aspire support (Visual Studio 2022 17.9+, VS Code with C# Dev Kit, or JetBrains Rider)
- An IDE with Aspire support, such as one of the following:
- Visual Studio 2022 version 17.9+
- Visual Studio Code with C# Dev Kit and the [`microsoft-aspire.aspire-vscode`](https://marketplace.visualstudio.com/items?itemName=microsoft-aspire.aspire-vscode) extension.
- JetBrains Rider
- Familiarize yourself with the [Aspire Orleans integration pack](https://aspire.dev/integrations/frameworks/orleans)

## Required packages

Expand Down Expand Up @@ -91,7 +95,7 @@ For separate client projects, configure the Orleans client similarly:

## AppHost extension methods reference

The `Aspire.Hosting.Orleans` package provides these extension methods:
The [`Aspire.Hosting.Orleans` package](https://www.nuget.org/packages/Aspire.Hosting.Orleans) provides these extension methods:

### Core methods

Expand Down
Loading