Skip to content

docs: add Orleans 10 to 11 preview migration guide - #11559

Open
ReubenBond wants to merge 16 commits into
dotnet:mainfrom
ReubenBond:rb-orleans-10-to-11-migration-guide
Open

ReubenBond wants to merge 16 commits into
dotnet:mainfrom
ReubenBond:rb-orleans-10-to-11-migration-guide

Conversation

@ReubenBond

@ReubenBond ReubenBond commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Problem

Applications and provider authors need an actionable upgrade path from Orleans 10 to 11.0.0-preview.1, including the default distributed grain directory and source/binary-breaking transport changes.

Solution

  • Add the version-to-version guide with concrete actions, failure detection, deployment qualification, and recovery constraints.
  • Cover transport/TLS migration, immutable silo hashes, contract identities and persisted aliases, strict configuration parsing, DynamoDB service identity, cancellation/statistics obsoletions, KubernetesClient, ADO.NET key formats and repeatable persistence scripts, cancellable gateway discovery, membership settings, NATS, journaling, and runtime/serialization behavior.
  • Link the integrated directory migration guide using the canonical legacy-to-distributed, existing-directory, and uniform-hash anchors. Preserve the staged one-way transition, explicit UseLegacyGrainDirectory deferral, accepted mixed-phase duplicates, and strict final convergence.
  • Add the guide to the existing Upgrade and migration navigation beside the contract-identities and grain-directory pages, and update the overview and related cross-links. Main deployment guidance remains version-neutral.

Integration

Rebased onto main after #9882 merged. This PR contains documentation changes only; its runtime prerequisite is now on the base branch. The previous missing-page blocker is resolved.

The guide includes merged #11570, #11588/#11589, #11604, and #11563. Unmerged proposals #11568 and #11614 are excluded. API names and migration claims were checked against the integrated source and generated API surfaces.

Microsoft Reviewers: Open in CodeFlow

Copilot AI balanced review requested due to automatic review settings October 21, 2026 20:56

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.

🔵 Needs a closer look

The one-way directory migration and coordinated pending release changes need maintainer confirmation before publication.

2 open issues
What changed in this PR

Adds an Orleans 10-to-11 preview migration guide covering application and provider compatibility, deployment, and recovery.

Changes:

  • Documents directory transitions, transport changes, and provider migration steps.
  • Adds qualification checks and rollback guidance.
  • Updates navigation and related upgrade links.
File Description
docs/​site/​src/​content/​docs/​toc.yml Adds Orleans 11 navigation.
docs/​site/​src/​content/​docs/​migration/​deployment-and-rollback.md Links release-specific prerequisites.
docs/​site/​src/​content/​docs/​migration/​9-to-10.md Links the next upgrade guide.
docs/​site/​src/​content/​docs/​migration/​10-to-11.md Adds the preview migration procedure.
docs/​site/​src/​content/​docs/​migration-guide.md Updates upgrade paths and package guidance.
docs/​site/​src/​content/​docs/​deployment/​upgrades.md Links Orleans 11 deployment prerequisites.

Review effort: Balanced

Comment thread docs/site/src/content/docs/migration/10-to-11.md Outdated
Comment thread docs/site/src/content/docs/migration/10-to-11.md Outdated
Copilot AI balanced review requested due to automatic review settings October 21, 2026 21:04

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.

🔵 Needs a closer look

The one-way directory migration requires maintainer confirmation of the pending opt-out API and authoritative upgrade procedure.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 21, 2026 21:09

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.

🟡 Changes recommended

The declared prerequisite currently lacks the opt-out API and directory migration procedure needed to follow the documented rollout.

1 open issue

Review effort: Balanced

Comment thread docs/site/src/content/docs/migration/10-to-11.md Outdated
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Code coverage

Metric Pull request Current main Variance
Lines 83.97% (120,446 / 143,437) 83.98% (120,463 / 143,437) -0.0119 pp
Branches 73.77% (36,034 / 48,846) 73.77% (36,036 / 48,846) -0.0041 pp

Report-only conclusion: regressed.

The current-main baseline is commit 845672b8d8 and uses the same reviewed coverage matrix.

Coverage combines every CI test matrix job, including providers, CodeGen, .NET 8/10, Linux, Windows, and macOS, using canonical physical source and branch identities.

The comparison remains report-only while normal line and branch variance is calibrated.

Coverage details

Copilot AI balanced review requested due to automatic review settings October 21, 2026 22:27

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.

🔵 Needs a closer look

Final approval requires integration of directory prerequisites #9882 and #11564, followed by API-reference and site-link validation.

1 open issue

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 21, 2026 23:00

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.

🔵 Needs a closer look

Publication remains gated on integrating #9882 and validating the resulting directory API references and documentation links.

1 open issue

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 22, 2026 00:46

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.

🔵 Needs a closer look

Publication remains gated on integrating #9882 and validating site links and generated API references against the integrated tree.

1 open issue

Review effort: Balanced

@ReubenBond
ReubenBond force-pushed the rb-orleans-10-to-11-migration-guide branch from a77ce2e to 1efe7c0 Compare October 28, 2026 19:15
Copilot AI balanced review requested due to automatic review settings October 28, 2026 19:15

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.

🟢 Approval recommended

No active review issues are reported for the Orleans 10-to-11 migration guide and related documentation updates.

1 open issue

Review effort: Balanced

This branch has not been deployed

No deployments
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