docs(operations): add production cluster runbook guidance - #10675
Merged
ReubenBond merged 1 commit intoAug 19, 2026
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new operations-focused guide to help production operators manage Orleans clusters after initial deployment (configuration changes, maintenance, recovery exercises, and incident/runbook preparation) and wires it into the existing deployment documentation navigation.
Changes:
- Adds a new “Operate a production cluster” production operations guide with concrete guidance on configuration control, maintenance sequencing, operational exercises, and runbook content.
- Links the new guide from the deployment hub and updates the production-readiness checklist to reference it.
- Adds the guide to the docs navigation (TOC) under “Deploy and operate”.
Show a summary per file
| File | Description |
|---|---|
| docs/site/src/content/docs/toc.yml | Adds the new production operations guide to the “Deploy and operate” navigation section. |
| docs/site/src/content/docs/deployment/production-readiness.md | Updates the checklist to point operators to the new production operations guidance/runbook expectations. |
| docs/site/src/content/docs/deployment/production-operations.md | Introduces the new production operations/runbook guidance document. |
| docs/site/src/content/docs/deployment/index.md | Links the new guide from the deployment “Operations track” hub page. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 4/4 changed files
- Comments generated: 0
- Review effort level: Lite
This was referenced Aug 28, 2026
Merged
Merged
This was referenced Sep 4, 2026
This was referenced Sep 8, 2026
Closed
This was referenced Sep 16, 2026
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
Operators need practical guidance for managing Orleans after initial deployment, including configuration changes, routine maintenance, recovery exercises, and incident runbooks.
Solution
Add a production operations guide that defines responsibility boundaries across the host, Orleans runtime, providers, and application. Document environment records, change classification, bounded configuration rollout with observability gates and rollback compatibility, safe maintenance sequencing, operational exercises, and minimum runbook content, then link the guide from the deployment hub, readiness checklist, and navigation.
Rationale
A focused operator workflow connects the existing upgrade, shutdown, observability, configuration, and rollback material without duplicating those detailed guides. It makes Orleans runtime guarantees and deployment-environment responsibilities explicit for production change control.
Closes #3228
Microsoft Reviewers: Open in CodeFlow