Orleans.Clustering.Kubernetes 2.0.0

Microsoft Orleans clustering provider backed by Kubernetes

Install-Package Orleans.Clustering.Kubernetes -Version 2.0.0
dotnet add package Orleans.Clustering.Kubernetes --version 2.0.0
<PackageReference Include="Orleans.Clustering.Kubernetes" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Orleans.Clustering.Kubernetes --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Configuration

A functional Kubernetes cluster is required for this provider to work. If you don't have one yet, there are multiple (and mostly complicated) ways to deploy Kubernetes for production use and it is out of scope of this provider as there are many articles around the web on how to do it. However, if you are playing with Docker and Kubernetes for the first time or you want to build a development box, Scott Hanselman has a nice article showing how to easily setup Docker for Windows with Kubernetes on your machine. Although it shows Windows 10, it can be easily adopted to Mac OSX as well.

Custom Resource Definitions

You need to apply both .yaml files from the package before starting the silo. It must be done once per Kubernetes cluster.

Note: You can also deploy the CRDs from the files on the Definitions directory on this repo.

Silo

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

var silo = new SiloBuilder()
        ...
        .UseKubeMembership()
        ...
        .Build();

Client

Now that our silo is up and running, the Orleans client needs to connect to the Kubernetes to look for Orleans Gateways.

var client = new ClientBuilder()
        ...
        .UseKubeGatewayListProvider() // Optionally use the configure delegate to specify the namespace where you cluster is running.
        ...
        .Build();

The provider will discover the cluster based on the kubernetes namespace the silo pod is running. In the case of the client, if a configure delegate with the Namespace property set to a non-null value is specified, it will ignore the current running pod namespace and will try to use that namespace instead.

Great! Now enjoy your Orleans application running within a Kubernetes cluster without needing an external membership provider!

Configuration

A functional Kubernetes cluster is required for this provider to work. If you don't have one yet, there are multiple (and mostly complicated) ways to deploy Kubernetes for production use and it is out of scope of this provider as there are many articles around the web on how to do it. However, if you are playing with Docker and Kubernetes for the first time or you want to build a development box, Scott Hanselman has a nice article showing how to easily setup Docker for Windows with Kubernetes on your machine. Although it shows Windows 10, it can be easily adopted to Mac OSX as well.

Custom Resource Definitions

You need to apply both .yaml files from the package before starting the silo. It must be done once per Kubernetes cluster.

Note: You can also deploy the CRDs from the files on the Definitions directory on this repo.

Silo

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

var silo = new SiloBuilder()
        ...
        .UseKubeMembership()
        ...
        .Build();

Client

Now that our silo is up and running, the Orleans client needs to connect to the Kubernetes to look for Orleans Gateways.

var client = new ClientBuilder()
        ...
        .UseKubeGatewayListProvider() // Optionally use the configure delegate to specify the namespace where you cluster is running.
        ...
        .Build();

The provider will discover the cluster based on the kubernetes namespace the silo pod is running. In the case of the client, if a configure delegate with the Namespace property set to a non-null value is specified, it will ignore the current running pod namespace and will try to use that namespace instead.

Great! Now enjoy your Orleans application running within a Kubernetes cluster without needing an external membership provider!

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Orleans.Clustering.Kubernetes:

Package Downloads
Orleans.Contrib.UniversalSilo
This library provides primitives to set up a configurable, application-agnostic Orleans silo and clients. Use it with the Orleans.Contrib.UniversalSilo.Templates to get started with Orleans.
iotsecurityinfra
Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.0.0 4,462 6/11/2020
1.2.2 10,985 3/22/2020
1.2.1 26,639 2/9/2020
1.2.0 1,560 1/25/2020
1.1.1 53,815 7/9/2019
1.1.0 7,768 3/21/2019
1.0.20 18,928 10/23/2018
1.0.19 10,667 7/10/2018
1.0.18 3,860 3/28/2018
1.0.0-rc2-15 454 3/13/2018
1.0.0-rc1-13 399 3/6/2018
1.0.0-rc1-11 328 2/27/2018
1.0.0-preview-7 506 2/9/2018
1.0.0-preview-5 364 2/9/2018