docs: add deployment guides for supported hosting targets - #10746
Merged
ReubenBond merged 4 commits intoAug 21, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands Orleans production deployment documentation by adding a deployment-target comparison matrix, introducing a dedicated Azure Kubernetes Service (AKS) guide, and aligning Azure Container Apps and Azure App Service guidance around a consistent operational “production checklist” structure. It fits into the docs site’s “Deploy and operate” area to help users select a supported hosting target and apply shared Orleans runtime invariants across platforms.
Changes:
- Added “Choose a deployment target” matrix page and updated navigation/cross-links to make target selection and shared production outcomes easier to follow.
- Added a dedicated AKS production guide covering Azure networking, workload identity, zonal placement, autoscaling, upgrades, and observability.
- Introduced an Azure App Service overview page and standardized “Production checklist” sections for Azure Container Apps and App Service (Windows/Linux), plus supporting cross-links.
Show a summary per file
| File | Description |
|---|---|
| docs/site/src/content/docs/toc.yml | Reorganized deployment navigation and added entries for the new target matrix and Azure-specific guides. |
| docs/site/src/content/docs/deployment/platform-guides.md | Added cross-links to the target matrix and AKS/App Service overview pages. |
| docs/site/src/content/docs/deployment/kubernetes.md | Linked to the new AKS guide and the target matrix for comparisons. |
| docs/site/src/content/docs/deployment/index.md | Updated “choose a platform” section to point to the target matrix and new/updated target guides. |
| docs/site/src/content/docs/deployment/deploy-to-azure-container-apps.md | Clarified the maintained ACA topology and added a structured production checklist section. |
| docs/site/src/content/docs/deployment/deploy-to-azure-app-service.md | Added link to the App Service overview and replaced “production considerations” with a checklist-style section. |
| docs/site/src/content/docs/deployment/deploy-to-azure-app-service-linux.md | Added link to the App Service overview and added a checklist-style production section aligned with Windows. |
| docs/site/src/content/docs/deployment/containers.md | Added a platform-qualification section and linked to the target matrix and shared readiness guidance. |
| docs/site/src/content/docs/deployment/choose-deployment-target.md | New page providing target selection matrix plus shared lifecycle, scaling, and production coverage matrices. |
| docs/site/src/content/docs/deployment/azure-kubernetes-service.md | New AKS-specific production guide layering Azure concerns on top of the Kubernetes baseline. |
| docs/site/src/content/docs/deployment/azure-app-service.md | New App Service target overview page linking to Windows/Linux guides and summarizing supported topology and validation. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 11/11 changed files
- Comments generated: 0
- Review effort level: Lite
ReubenBond
force-pushed
the
rb-issue-10721-deployment-guides
branch
from
August 21, 2026 13:43
a981186 to
95a5694
Compare
Contributor
There was a problem hiding this comment.
Review details
Suppressed comments (1)
docs/site/src/content/docs/toc.yml:289
- The "Azure App Service" entry under Deploy and operate � Deployment targets links only to the overview page, so readers can�t navigate directly to the Windows/Linux guides from the deployment-target section. Consider nesting the OS-specific guides here (and removing any duplicate entries elsewhere) to keep the deployment navigation self-contained.
- name: Azure App Service
href: deployment/azure-app-service.md
- Files reviewed: 11/11 changed files
- Comments generated: 1
- Review effort level: Lite
ReubenBond
force-pushed
the
rb-issue-10721-deployment-guides
branch
from
August 21, 2026 15:33
2a5a440 to
d51152f
Compare
ReubenBond
force-pushed
the
rb-issue-10721-deployment-guides
branch
from
August 21, 2026 16:59
d1fe654 to
c5f0cf8
Compare
This was referenced Sep 8, 2026
Closed
This was referenced Sep 16, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Orleans deployment guidance covered several platforms but did not provide a target-selection matrix, a dedicated AKS production path, or a consistent operational structure across the maintained Azure targets.
Solution
Rationale
The structure keeps Orleans runtime invariants in shared pages while each target guide documents the platform mechanisms and supported deployment shape needed to satisfy them.
Fixes #10721
Microsoft Reviewers: Open in CodeFlow