Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piotrjustyna/road-to-orleans
This repository illustrates the road to orleans with practical, real-life examples. From most basic, to more advanced techniques.
https://github.com/piotrjustyna/road-to-orleans
actor-model cancellationtoken configuration containers csharp datadog distributed-systems docker dynamodb feature-flags featuremanagement fsharp grains orleans orleans-cluster orleans-example orleans-grains silo unittest webapi
Last synced: 3 months ago
JSON representation
This repository illustrates the road to orleans with practical, real-life examples. From most basic, to more advanced techniques.
- Host: GitHub
- URL: https://github.com/piotrjustyna/road-to-orleans
- Owner: PiotrJustyna
- License: mit
- Created: 2020-11-30T09:52:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T15:27:06.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T16:44:37.777Z (4 months ago)
- Topics: actor-model, cancellationtoken, configuration, containers, csharp, datadog, distributed-systems, docker, dynamodb, feature-flags, featuremanagement, fsharp, grains, orleans, orleans-cluster, orleans-example, orleans-grains, silo, unittest, webapi
- Language: C#
- Homepage:
- Size: 3.38 MB
- Stars: 147
- Watchers: 10
- Forks: 29
- Open Issues: 43
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
- [road to orleans](#road-to-orleans)
- [build & run](#build--run)
- [monitoring](#monitoring)
- [code](#code)
- [further reading](#further-reading)
# road to orleans
[](https://gitter.im/road-to-orleans/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
This repository illustrates the road to orleans with practical, real-life examples such as .NET solutions. From most basic to more advanced techniques. The code is written using .NET 6 and was tested on macOS (Catalina 10.15.7) and, wherever docker is supported, Linux (Alpine 3.12).
## build & run
- IDE: build + run (first the cluster, then the client)
- `run-[client/silo]-[docker/local].sh`
## monitoring
Silo dashboards are available by default on `localhost:8080` unless configured otherwise in the code/`dockerfile`/`run-[client/silo]-[docker/local].sh`. Additionally, Datadog APM support is illustrated in solution 3b.
## code
```mermaid
flowchart TD
Solution1(Solution1: One basic silo, no grains.)
Solution2(Solution2: One basic silo, one grain, one console client.)
Solution3(Solution3: One basic silo, one grain, one console client,
everything containerized.)
Solution3a(Solution3a: Solution3 + grain persistence.)
Solution3b(Solution3b: Solution3 + datadog APM.)
Solution4(Solution4: First in-memory clustering example.
Many silos, many clients.)
Solution5(Solution5: Solution4 where the grain interfaces F# library code.
Additionally, F# unit tests covering the F# library code.)
Solution5a(Solution5a: Solution5 where the host and client are written in F#.)
Solution6(Solution6: Solution5 where the cluster is being called from a Web API.)
Solution7(Solution7: Solution6 + FeatureManagement, dependency injection in grains,
unit tests for grains using OrleansTestKit.)
Solution8(Solution8: Solution7 + Persistent Membership Table in DynamoEB,
ECS hosting, CloudFormation Template.)
Solution1 --> Solution2
Solution2 --> Solution3
Solution3 --> Solution3a
Solution3 --> Solution3b
Solution3 --> Solution4
Solution4 --> Solution5
Solution5 --> Solution5a
Solution5 --> Solution6
Solution6 --> Solution7
Solution7 --> Solution8
```
| solution | description | docker support | clustering | clustered silos | grains | clients | \*visual studio code support | \*remote containers support |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------- | --------------- | --------------------------------------- | ----------- | ---------------------------- | --------------------------- |
| [solution1](1/readme.md) | One basic silo, no grains. | :white_check_mark: | - | 1 | 0 | 0 | :white_check_mark: | :white_check_mark: |
| [solution2](2/readme.md) | One basic silo, one grain, one console client. | - | - | 1 | 1 C# grain | 1 - console | :white_check_mark: | :white_check_mark: |
| [solution3](3/readme.md) | One basic silo, one grain, one console client, everything containerized. | :white_check_mark: | - | 1 | 1 C# grain | 1 - console | :white_check_mark: | :white_check_mark: |
| [solution3a](3a/readme.md) | Solution3 + grain persistence. | :white_check_mark: | - | 1 | 1 C# grain | 1 - console | :white_check_mark: | :white_check_mark: |
| [solution3b](3b/readme.md) | Solution3 + datadog APM. | :white_check_mark: | - | 1 | 1 C# grain | 1 - console | :white_check_mark: | :white_check_mark: |
| [solution4](4/readme.md) | First in-memory clustering example. Many silos, many clients. | :white_check_mark: | in-memory | n | 1 C# grain | n - console | :white_check_mark: | :white_check_mark: |
| [solution5](5/readme.md) | Solution4 where the grain interfaces F# library code. Additionally, F# unit tests covering the F# library code. | :white_check_mark: | in-memory | n | 1 C# grain interfacing F# library code. | n - console | | :white_check_mark: |
| [solution5a](5a/readme.md) | Solution5 where the host and client are written in F#. | :white_check_mark: | in-memory | n | 1 F# grain interfacing F# library code. | n - console | | :white_check_mark: |
| [solution6](6/readme.md) | Solution5 where the cluster is being called from a Web API. | :white_check_mark: | in-memory | n | 1 C# grain interfacing F# library code | n - web api | | :white_check_mark: |
| [solution7](7/readme.md) | Solution6 + [FeatureManagement](https://www.nuget.org/packages/Microsoft.FeatureManagement/), dependency injection in grains, unit tests for grains using [OrleansTestKit](https://www.nuget.org/packages/OrleansTestKit/). | :white_check_mark: | in-memory | n | 1 C# grain interfacing F# library code | n - web api | | :white_check_mark: |
| [solution8](8/readme.md) | Solution7 + Persistent Membership Table in DynamoEB, ECS hosting, CloudFormation Template. | :white_check_mark: | Dynamo | n | 1 C# grain interfacing F# library code | n - web api | | :white_check_mark: |
\*visual studio code support:
- `[ctrl/cmd]+shift+b`: builds selected projects
- `f5`: runs selected projects
\*remote containers support: ability to develop/build/run/debug code inside [containers](https://code.visualstudio.com/docs/remote/containers). This is to support those who just want to quickly pull the repository code and experiment with it with e.g. Visual Studio Code. Code + batteries included.
## further reading
- https://gitter.im/road-to-orleans/community - road to Orleans gitter
- https://github.com/dotnet/orleans - Orleans repository
- https://dotnet.github.io/orleans/ - Orleans documentation
- https://docs.microsoft.com/en-us/dotnet/orleans/ - New Orleans documentation
- https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/Orleans20Best20Practices.pdf - Orleans best practices
- https://gitter.im/dotnet/orleans/ - Orleans gitter
- https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/Orleans-MSR-TR-2014-41.pdf - virtual actors paper
- https://github.com/OrleansContrib - orbiting repositories (e.g. Orleans dashboard)
- https://github.com/PiotrJustyna/FeatureManagementSandbox - more involved use cases for [FeatureManagement](https://www.nuget.org/packages/Microsoft.FeatureManagement/)
## to watch
- https://youtu.be/GKXiGhFBd90 - observability: logs, tracing, metrics
- https://youtu.be/R0ODfwU6MzQ - orleans: deep dive