Orleans NuGet packages as of v1.5.0
There are 4 key NuGet packages you will need to use in most scenarios:
PM> Install-Package Microsoft.Orleans.OrleansCodeGenerator.Build
Build support for grain interfaces and implementation projects.
Add it to your grain interfaces and implementation projects to enable code generation of grain references and serializers.
Microsoft.Orleans.Templates.Grains packages are obsolete and provided only for backward compatibility and migration.
PM> Install-Package Microsoft.Orleans.Core
Contains Orleans.dll, which defines most of Orleans public types and Orleans Client. Reference it for building libraries and client applications that use Orleans types but don't need any of the included providers.
PM> Install-Package Microsoft.Orleans.Server
Includes everything you need to run a silo.
PM> Install-Package Microsoft.Orleans.Client
Includes everything you need for an Orleans client (frontend).
The below packages provide additional functionality.
PM> Install-Package Microsoft.Orleans.OrleansProviders
Contains a set of built-in persistence and stream providers, primarily for testing, as well as some abstractions and utility types for building persistence and stream providers. Included in Microsoft.Orleans.Client and Microsoft.Orleans.Server.
PM> Install-Package Microsoft.Orleans.EventSourcing
Contains a set of base types for creating grain classes with event-sourced state.
Providers and extensions
PM> Install-Package Microsoft.Orleans.OrleansAzureUtils
Contains Azure Table based cluster membership provider, wrapper classes that simplify instantiation of silos and clients in Azure Worker/Web roles, persistence providers for Azure Tables and Azure Blobs, and a stream provider for Azure Queues.
PM> Install-Package Microsoft.Orleans.OrleansSqlUtils
Contains SQL based cluster membership and persistence providers for use with SQL Server, MySQL, PostgreSQL, and other SQL databases.
PM> Install-Package Microsoft.Orleans.OrleansServiceBus
Includes the stream provider for Azure Event Hubs.
PM> Install-Package Microsoft.Orleans.OrleansConsulUtils
Includes the plugin for using Consul for storing cluster membership data.
PM> Install-Package Microsoft.Orleans.OrleansZooKeeperUtils
Includes the plugin for using ZooKeeper for storing cluster membership data.
PM> Install-Package Microsoft.Orleans.OrleansAWSUtils
Includes DynamoDB based cluster membership provider, DynamoDB persistence provider, and SQS based stream provider.
PM> Install-Package Microsoft.Orleans.OrleansTelemetryConsumers.Counters
Windows Performance Counters implementation of Orleans Telemetry API.
PM> Install-Package Microsoft.Orleans.OrleansTelemetryConsumers.AI
Includes the telemetry consumer for Azure Application Insights.
PM> Install-Package Microsoft.Orleans.OrleansTelemetryConsumers.NewRelic
Includes the telemetry consumer for NewRelic.
PM> Install-Package Microsoft.Orleans.Serialization.Bond
Includes support for Bond serializer.
PM> Install-Package Microsoft.Orleans.OrleansGoogleUtils
Includes Google Protocol Buffers serializer.
Hosting and testing
PM> Install-Package Microsoft.Orleans.OrleansRuntime
Core runtime library of Microsoft Orleans that hosts and executes grains within a silo.
PM> Install-Package Microsoft.Orleans.OrleansHost
Includes the default silo host - OrleansHost.exe. Can be used for on-premises deployments or as an out-of-process silo host in Azure Worker Role. Included in Microsoft.Orleans.Server. We are planning to deprecate this package in favor of customers building their custom silo host processes in order to simplify dependency management and programmatic configuration.
PM> Install-Package Microsoft.Orleans.ServiceFabric
Support for hosting Microsoft Orleans on Service Fabric.
PM> Install-Package Microsoft.Orleans.TestingHost
Includes the library for hosting silos in a testing project.
PM> Install-Package Microsoft.Orleans.OrleansCodeGenerator
Includes the run time code generator. Included in Microsoft.Orleans.Server and Microsoft.Orleans.Client.
PM> Install-Package Microsoft.Orleans.CounterControl
Includes OrleansCounterControl.exe, which registers Windows performance counter categories for Orleans statistics and for deployed grain classes. Requires elevation. Can be executed in Azure as part of a role startup task. Included in Microsoft.Orleans.Server.
PM> Install-Package Microsoft.Orleans.OrleansManager
Includes Orleans management tool - OrleansManager.exe. We are planning to deprecate this package in favor of customers building their custom management tools in order to simplify dependency management and programmatic configuration.