1.5.x branch 2.x.x branch

Orleans is a framework that provides a straight-forward approach to building distributed high-scale computing applications, without the need to learn and apply complex concurrency or other scaling patterns.

Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.

StackExchange.Redis library underneath.

PS> Install-Package Orleans.Persistence.Redis -prerelease

Configure your Orleans silos

var silo = new SiloHostBuilder()
    .AddRedisGrainStorage("Redis", optionsBuilder => optionsBuilder.Configure(options =>
    {
        options.DataConnectionString = "localhost:6379"; // This is the deafult
        options.UseJson = true;
        options.DatabaseNumber = 1;
    }))
    .Build();
await silo.StartAsync();

Decorate your grain classes with the StorageProvider attribute.

[StorageProvider(ProviderName = "Redis")]
public class SomeGrain : Grain<SomeGrainState>, ISomeGrain

These settings will enable the Redis cache to act as the store for grains that have persistent state.

• DataConnectionString="..." (required) the connection string to your redis database (i.e. localhost:6379, is passed directly to StackExchange.Redis)
• UseJson=true/false (optional) wether or not to persist state as a JSON string or not. Defaults to false
• DatabaseNumber=1 (optional) the number of the redis database to connect to. Defaults

Orleans clustering provider for Redis

Orleans.Clustering.Redis enables Orleans applications to use Redis as a backend for cluster membership.

Redis is a straight key/value store. Membership data is stored as a hash.

If you want to quickly test it, clone this repo and go to the samples directory for instructions on how to run a sample cluster.

Installation is performed via NuGet

From Package Manager:

Install-Package Orleans.Clustering.Redis

.Net CLI:

dotnet add package Orleans.Clustering.Redis

A functional Redis database is required for this provider to work.

Tell Orleans runtime that we are going to use Redis as our Cluster Membership Provider:

var silo = new SiloHostBuilder()
        ...
        .UseRedisClustering(opt =>
        {
            opt.ConnectionString = "host:port";
            opt.Database = 0;
        })
        ...
        .Build();

ConnectionString tells the connector where to find the Redis database.

Database is an integer which tells the membership table which database to get after connecting to the Redis service.

More information on connection string configuration can be found at on the StackExchange.Redis driver site (https://stackexchange.github.io/StackExchange.Redis/Configuration.html).

Now that our silo is up and running, the Orleans client needs to connect to the Redis database to look for Orleans gateways.

var client = new ClientBuilder()
        ...
        .UseRedisClustering(opt =>
        {
            opt.ConnectionString = "host:port";
            opt.Database = 0;
        })
        ...
        .Build();

At the moment the gateway list is provided by the underlying membership provider directly.

This project is licensed under the MIT license.