Orleans how-to guides
Use these recipes when you have a specific task to complete. Each guide focuses on prerequisites, the shortest supported path, and the checks which confirm that the change worked.
If you are learning Orleans from an empty directory, start with the tutorials and walkthroughs. For the ideas behind these tasks, see Orleans concepts and Why Orleans?. For the runtime behavior behind a recommendation, see Architecture and internals.
Configure hosting and providers
Section titled “Configure hosting and providers”- Configure a silo
- Configure an external client
- Choose a typical configuration
- Configure ADO.NET providers
- Configure Consul clustering
- Configure serialization
- Configure TLS
- Configure Aspire integration
Deploy and operate
Section titled “Deploy and operate”- Review production readiness
- Configure topology, networking, and clustering
- Deploy to Kubernetes
- Deploy to Azure App Service
- Deploy to Azure Container Apps
- Plan capacity and scaling
- Perform a graceful upgrade
- Plan disaster recovery
Use Orleans features
Section titled “Use Orleans features”- Persist grain state
- Configure experimental Journaling
- Schedule activation-scoped work with grain timers
- Schedule durable work with reminders
- Implement long-running reminders
- Configure Amazon DynamoDB reminders
- Configure streams
- Use response streaming
- Use stateless worker grains
- Test an Orleans application
Diagnose and recover
Section titled “Diagnose and recover”- Troubleshoot a deployment
- Troubleshoot Orleans incidents
- Monitor silo and client error codes
- Configure signals and alerting
- Handle failures and uncertain outcomes
- Troubleshoot experimental Orleans Journaling
For public types, defaults, exceptions, and overloads, use the C# API reference. Reference entries provide the precise contract; the recipes above show how to apply it.