Skip to content

docs(operations): add production cluster runbook guidance - #10675

Merged
ReubenBond merged 1 commit into
dotnet:mainfrom
ReubenBond:rb-issue-3228-production-operations-docs
Aug 19, 2026
Merged

ReubenBond merged 1 commit into
dotnet:mainfrom
ReubenBond:rb-issue-3228-production-operations-docs

Conversation

@ReubenBond

@ReubenBond ReubenBond commented Aug 19, 2026

Copy link
Copy Markdown
Member

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

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 19, 2026 10: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.

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

@ReubenBond
ReubenBond merged commit af6ca31 into dotnet:main Aug 19, 2026
71 of 73 checks passed
@ReubenBond
ReubenBond deleted the rb-issue-3228-production-operations-docs branch August 19, 2026 18:40
This was referenced Aug 28, 2026
This was referenced Sep 8, 2026
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve DevOps side of the documentation

2 participants