Skip to content

docs: modernize hosting and configuration guidance - #10335

Open
ReubenBond wants to merge 5 commits into
dotnet:mainfrom
ReubenBond:reubenbond-modernize-hosting-docs
Open

docs: modernize hosting and configuration guidance#10335
ReubenBond wants to merge 5 commits into
dotnet:mainfrom
ReubenBond:reubenbond-modernize-hosting-docs

Conversation

@ReubenBond

@ReubenBond ReubenBond commented Aug 2, 2026

Copy link
Copy Markdown
Member

Modernizes Orleans 10 hosting and configuration guidance across silo/client hosting, declarative configuration, networking, providers, Aspire, lifecycle, resource management, heterogeneous silos, metadata, and grain directories.

Replaces stale version pivots and hand-maintained option catalogs with task-oriented guidance backed by compiled snippets and current APIs.

Microsoft Reviewers: Open in CodeFlow

Refresh Orleans 10 hosting, configuration, provider, lifecycle, and resource-management guidance with compiled snippets.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9e7439a7-5779-41f5-8624-7c026ff31f3a
Copilot AI review requested due to automatic review settings August 2, 2026 21:33

Copilot AI left a comment

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.

Pull request overview

Modernizes Orleans 10 hosting/configuration documentation by replacing older version-pivoted reference material with task-oriented guidance and compiled snippet-backed examples across hosting models (co-hosted vs external client), providers, lifecycle, resource management, heterogeneous silos, metadata, grain directories, and Aspire integration.

Changes:

  • Adds a new compiled hosting snippets project (solution + Hosting project) and references it from updated docs pages.
  • Updates Aspire examples and package versions, including Azure Table client registration and Orleans Azure Storage provider packages.
  • Rewrites multiple hosting/configuration guide pages to align with current Orleans 10 APIs (lifecycle stage names/values, declarative config sections, shutdown behavior, activation collection, etc).
Show a summary per file
File Description
docs/site/src/content/docs/host/snippets/snippets.sln Adds the new Hosting snippets project to the snippets solution.
docs/site/src/content/docs/host/snippets/hosting/HostingExamples.cs Introduces compiled hosting/configuration examples used by multiple docs pages.
docs/site/src/content/docs/host/snippets/hosting/Hosting.csproj Adds the project which builds the hosting examples/snippets.
docs/site/src/content/docs/host/snippets/aspire/Silo/SiloProgram.cs Updates Aspire silo snippets (Azure Tables client registration API).
docs/site/src/content/docs/host/snippets/aspire/Silo/Silo.csproj Adds Orleans Azure Storage provider packages for Aspire-based Azure examples.
docs/site/src/content/docs/host/snippets/aspire/AppHost/AppHostExamples.cs Updates Aspire AppHost examples (Azure storage wiring for clustering/storage/reminders).
docs/site/src/content/docs/host/snippets/aspire/AppHost/AppHost.csproj Updates Aspire AppHost SDK and package versions.
docs/site/src/content/docs/host/silo-lifecycle.md Updates lifecycle stage guidance and references compiled snippets.
docs/site/src/content/docs/host/heterogeneous-silos.md Updates heterogeneous silo guidance and adds compiled snippet references.
docs/site/src/content/docs/host/grain-directory.md Updates grain directory guidance, including experimental distributed directory notes.
docs/site/src/content/docs/host/configuration-guide/typical-configurations.md Replaces older “typical configs” catalog with scenario-based guidance and snippet links.
docs/site/src/content/docs/host/configuration-guide/startup-tasks.md Updates recommended approach (hosted services) and refines startup task guidance.
docs/site/src/content/docs/host/configuration-guide/silo-metadata.md Updates metadata guidance and examples for Orleans 10.
docs/site/src/content/docs/host/configuration-guide/shutting-down-orleans.md Updates shutdown guidance to emphasize Generic Host ownership and shutdown budget.
docs/site/src/content/docs/host/configuration-guide/server-configuration.md Updates server configuration guidance and examples to current Orleans 10 APIs.
docs/site/src/content/docs/host/configuration-guide/local-development-configuration.md Updates local development guidance and references compiled snippets.
docs/site/src/content/docs/host/configuration-guide/list-of-options-classes.md Replaces exhaustive list with curated “core options” starter set and guidance.
docs/site/src/content/docs/host/configuration-guide/index.md Updates configuration guide overview, including declarative configuration section map.
docs/site/src/content/docs/host/configuration-guide/configuring-garbage-collection.md Updates GC guidance for Orleans 10, including container considerations.
docs/site/src/content/docs/host/configuration-guide/configuring-ado-dot-net-providers.md Updates ADO.NET provider guidance and adds declarative configuration examples.
docs/site/src/content/docs/host/configuration-guide/client-configuration.md Updates external client guidance, including connection resiliency and Aspire notes.
docs/site/src/content/docs/host/configuration-guide/adonet-configuration.md Updates ADO.NET schema script links and invariants for Orleans 10.
docs/site/src/content/docs/host/configuration-guide/activation-collection.md Updates activation collection/resource management guidance and compiled snippet usage.
docs/site/src/content/docs/host/client.md Updates client hosting model guidance and references updated snippets.
docs/site/src/content/docs/host/aspire-integration.md Updates Aspire integration guidance, examples, and operational notes.

Copilot's findings

Suppressed comments (2)

docs/site/src/content/docs/host/snippets/hosting/HostingExamples.cs:308

  • These declarations use a trailing ; (instead of a body), which is invalid C# and will break snippet compilation. Use an empty interface/class body.
public interface IRecommendationGrain : IGrainWithStringKey;

public sealed class RecommendationGrain : Grain, IRecommendationGrain;

docs/site/src/content/docs/host/snippets/hosting/HostingExamples.cs:312

  • These declarations use a trailing ; (instead of a body), which is invalid C# and will break snippet compilation. Use an empty interface/class body.
public interface IModelRegistryGrain : IGrainWithStringKey;

public sealed class ModelRegistryGrain : Grain, IModelRegistryGrain;

  • Files reviewed: 25/25 changed files
  • Comments generated: 1

Comment thread docs/site/src/content/docs/host/snippets/hosting/HostingExamples.cs Outdated
Remove named-release framing from hosting and configuration prose while retaining required package and runtime literals.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9e7439a7-5779-41f5-8624-7c026ff31f3a
Copilot AI review requested due to automatic review settings August 3, 2026 17:23

Copilot AI left a comment

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.

Copilot's findings

Suppressed comments (2)

docs/site/src/content/docs/host/snippets/hosting/HostingExamples.cs:7

  • Microsoft.AspNetCore.Http is not used in this snippet and can introduce CS8019 warnings (which can break snippet compilation when warnings are treated as errors). Remove the unused using directive.
using System.Net;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

docs/site/src/content/docs/host/snippets/hosting/Hosting.csproj:21

  • These snippet projects already centralize package versions in docs/site/src/content/docs/Directory.Build.props via PackageReference Update=.... Keeping explicit Version= attributes here duplicates the source of truth and risks version drift. Consider omitting Version attributes in this project and relying on the central snippet build props for versions.
  <ItemGroup>
    <PackageReference Include="Microsoft.Orleans.Server" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Client" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Clustering.Redis" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Persistence.Redis" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Reminders.Redis" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.GrainDirectory.Redis" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Clustering.AdoNet" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Persistence.AdoNet" Version="10.2.1" />
    <PackageReference Include="Microsoft.Orleans.Reminders.AdoNet" Version="10.2.1" />
  </ItemGroup>
  • Files reviewed: 25/25 changed files
  • Comments generated: 1

Comment thread docs/site/src/content/docs/host/configuration-guide/silo-metadata.md Outdated
Source the metadata-reading example from the hosting snippets project and use conventional empty type bodies.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9e7439a7-5779-41f5-8624-7c026ff31f3a
Copilot AI review requested due to automatic review settings August 5, 2026 13:17

Copilot AI left a comment

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.

Copilot's findings

  • Files reviewed: 25/25 changed files
  • Comments generated: 1

Comment thread docs/site/src/content/docs/host/snippets/hosting/HostingExamples.cs
ReubenBond added a commit to ReubenBond/orleans that referenced this pull request Aug 5, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9be838b5-7660-444e-b2c5-bf2e9b373472
Describe the Consul membership provider as using key/value storage without claiming session API usage.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9e7439a7-5779-41f5-8624-7c026ff31f3a
Copilot AI review requested due to automatic review settings August 5, 2026 14:07
ReubenBond added a commit to ReubenBond/orleans that referenced this pull request Aug 5, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9be838b5-7660-444e-b2c5-bf2e9b373472

Copilot AI left a comment

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.

Copilot's findings

  • Files reviewed: 25/25 changed files
  • Comments generated: 0 new

Link hosting, configuration, provider, runtime, Aspire, and infrastructure guidance to canonical sources and fix the transitive managed-identity link.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9e7439a7-5779-41f5-8624-7c026ff31f3a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants