ContextQMD
Back to Orleans

Microsoft Orleans Clustering for Azure Cosmos DB

src/Azure/Orleans.Clustering.Cosmos/README.md

10.1.01.9 KB
Original Source

Microsoft Orleans Clustering for Azure Cosmos DB

Introduction

Microsoft Orleans Clustering for Azure Cosmos DB provides cluster membership functionality for Microsoft Orleans using Azure Cosmos DB. This allows Orleans silos to coordinate and form a cluster using Azure Cosmos DB as the backing store.

Getting Started

To use this package, install it via NuGet:

shell
dotnet add package Microsoft.Orleans.Clustering.Cosmos

Example - Configuring Azure Cosmos DB Membership

csharp
using Microsoft.Extensions.Hosting;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseCosmosClustering(options =>
            {
                options.AccountEndpoint = "https://YOUR_COSMOS_ENDPOINT";
                options.AccountKey = "YOUR_COSMOS_KEY";
                options.DB = "YOUR_DATABASE_NAME";
                options.CanCreateResources = true;
            });
    });

// Run the host
await builder.RunAsync();

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing