https://github.com/interflare/orleans-marten
Marten implementation of the Orleans providers: clustering, state, and reminders
https://github.com/interflare/orleans-marten
dotnet marten orleans orleans-storage-provider postgres
Last synced: about 1 month ago
JSON representation
Marten implementation of the Orleans providers: clustering, state, and reminders
- Host: GitHub
- URL: https://github.com/interflare/orleans-marten
- Owner: interflare
- License: mit
- Created: 2025-01-10T09:25:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-01T06:39:22.000Z (about 2 months ago)
- Last Synced: 2025-03-01T22:16:10.844Z (about 2 months ago)
- Topics: dotnet, marten, orleans, orleans-storage-provider, postgres
- Language: C#
- Homepage:
- Size: 67.4 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Orleans Marten providers
[](https://www.nuget.org/packages/Interflare.Orleans.Marten.Clustering/)
[](https://www.nuget.org/packages/Interflare.Orleans.Marten.Persistence/)
[](https://www.nuget.org/packages/Interflare.Orleans.Marten.Reminders/)
[](https://github.com/interflare/orleans-marten/actions/workflows/ci.yml)
[](https://github.com/interflare/orleans-marten/actions/workflows/release.yml)
A [Marten](https://martendb.io/) implementation of [Orleans](https://docs.microsoft.com/dotnet/orleans) providers for **membership** (clustering), **state storage**, and **reminder
storage**. It makes use of your existing Marten project configuration and database management, and has a slim setup that's easy to get started with.
> [!TIP]
> Please tell us about your [usage](https://github.com/interflare/orleans-marten/discussions/categories/show-and-tell) and provide
> any [feedback](https://github.com/interflare/orleans-marten/discussions/categories/ideas) or [bug reports](https://github.com/interflare/orleans-marten/issues/new?labels=bug) in
> discussions and issues - it's greatly appreciated!
## Why this library
Orleans requires configuration of a backend storage provider in production to manage clustering and persist state. With Azure services, this is relatively easy to get set started
through Azure Table Storage - you can just point your cluster at the service, and you've got a production-ready system.
If you're not hosting in Azure, the storage options are not as easy to get started with. The ADO .NET (SQL) provider, for example, requires setting up the database tables manually
using loose SQL scripts you have to download and execute from several different places in the Orleans git repo.
This library is for applications which already use Marten as a data store in some way, or intend to use it - meaning that there is no additional or separate tooling to configure
just to run Orleans. The library automatically extends and uses your existing Marten config with tables for running Orleans.
## Installation
This repo publishes a package for each of the supported systems for Orleans, which you can add to your application as needed - install only the packages for the corresponding
service you wish to back with Marten.
- **Membership**: `dotnet add package Interflare.Orleans.Marten.Clustering`
- **State storage**: `dotnet add package Interflare.Orleans.Marten.Persistence`
- **Reminders**: `dotnet add package Interflare.Orleans.Marten.Reminders`
## Configuration
There isn't much to configure, you only need to tell the Orleans silo to use the providers:
```csharp
// Program.cs
var builder = WebApplication.CreateBuilder(args);
// Setup Orleans silo
builder.Host.UseOrleans(siloBuilder =>
{
// Interflare.Orleans.Marten.Clustering:
siloBuilder.UseMartenClustering();
// Interflare.Orleans.Marten.Reminders:
siloBuilder.UseMartenReminderService();
// Interflare.Orleans.Marten.Persistence:
siloBuilder.AddMartenGrainStorageAsDefault(); // or
siloBuilder.AddMartenGrainStorage(name: "MyStorageName");
});
// Example Marten configuration
// see: https://martendb.io/configuration/hostbuilder.html
builder.Services.AddMarten(options =>
{
options.Connection(configuration.GetConnectionString("MyDatabase"));
options.Schema.For();
options.Schema.For();
});
```
> [!IMPORTANT]
> You will need to perform [code generation](https://martendb.io/configuration/prebuilding.html#pre-building-generated-types) (if needed)
> and [run migrations](https://martendb.io/schema/migrations.html) on first use of these packages as well as any subsequent updates - as you would if you were creating and updating
> new tables of your own.
The Orleans provider configuration methods (`UseMartenClustering()` etc) will inject their Marten schema definitions into your existing configuration.
If you follow the Orleans recommendation to [co-host](https://learn.microsoft.com/en-us/dotnet/orleans/host/client) your clients in the same process as the silos, you are ready to
hit deploy and get going. These Marten providers will use the Orleans configuration for the [
`ClusterOptions`](https://learn.microsoft.com/en-us/dotnet/orleans/host/configuration-guide/server-configuration?pivots=orleans-7-0#orleans-clustering-information) (service/cluster
ids) as well as the serializers.
**Should you be hosting your clients external to the silos in separate projects**, you can configure the client projects with the `Interflare.Orleans.Marten.Clustering` library
like so:
```csharp
// Program.cs
var builder = WebApplication.CreateBuilder(args);
// Setup Orleans client
builder.Host.UseOrleansClient(clientBuilder =>
{
// Interflare.Orleans.Marten.Clustering:
clientBuilder.UseMartenClustering();
});
// You still need to configure Marten in your client projects
builder.Services.AddMarten(options =>
{
// ...
});
```