Akkatecture.Clustering 0.8.0

dotnet add package Akkatecture.Clustering --version 0.8.0                
NuGet\Install-Package Akkatecture.Clustering -Version 0.8.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Akkatecture.Clustering" Version="0.8.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Akkatecture.Clustering --version 0.8.0                
#r "nuget: Akkatecture.Clustering, 0.8.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Akkatecture.Clustering as a Cake Addin
#addin nuget:?package=Akkatecture.Clustering&version=0.8.0

// Install Akkatecture.Clustering as a Cake Tool
#tool nuget:?package=Akkatecture.Clustering&version=0.8.0                

<a href="https://akkatecture.net/"><img src="logo.svg?sanitize=true" width="100%" height="200"></a>

nuget master dev code coverage chat who are we?
Nuget Package Build status Build status Coverage Come Chat we are reactive


Akkatecture is a cqrs and event sourcing framework for dotnet core, build ontop of akka.net. Fully optimised around using akka's highly scalable message passing and event stream pub sub mechanisms. Akkatecture targets netstandard2.0.

Go ahead and take a look at our documentation, go over some concepts, and read the tips and tricks.


  • Distributed: Each aggregate can operate concurrently in parallel inside of the actor system with isolated failure boundaries.
  • Message based: Making it highly scalable by being reactive from message passing, Akkatecture does not ask, it tells.
  • Event sourced: By design, aggregate roots derive their state by replaying persisted events.
  • Highly scalable: Work proceeds interactively and concurrently, overlapping in time, and may be done across nodes.
  • Configurable: Through akka.net's hocon configuration, you will be able to configure every aspect of your application.


Akkatecture comes with a few prescribed examples on how one might use it:

  • Simple: A simple console based example that shows the most simple example of how to create an aggregate and issue commands to it.

  • Walkthrough: Tutorial style sample based on the walkthrough in the Akkatecture documentation. The walkthrough proposes domain that should be modelled based on some business requirements. The walkthrough goes step by step covering all the primitives and features covered in Akkatecture to give you an understanding of the framework. The beginning of the walkthrough can be found here.

  • Cluster: A more involved sample that shows you how to do distributed aggregates using clustering. Read the readme for the sample for a good overview of the example.

  • Web: This sample shows how to integrate akka into an aspnet core project, specifically how to inject actor references when using akkatecture. Furthermore this project models a long running process that might be run behind a web application or something similar. Read the readme for more detailed information about the example.

  • Jobs: A simple sample that demonstrates how you would make a scheduled persistent job. Jobs are commands that can be persisted and scheduled to be executed at any arbitrary trigger point in time. Read the readme for more detailed information about the example. The documentation for this can be found here.

  • Tests: The test examples found in the Akkatecture.Test project is there to provide assistance when doing testing for Akkatecture. There is a simple domain modelled within the Akkatecture.TestHelpers project that includes a model of an aggregate with a simple aggregate saga, and these are used to do simple black box style testing on Akkatecture using akka.net's TestKit.

Note: This example is part of the Akkatecture simple example project, so checkout the code and give it a run.

//Create actor system
var system = ActorSystem.Create("useraccount-example");

//Create supervising aggregate manager for UserAccount aggregate root actors
var aggregateManager = system.ActorOf(Props.Create(() => new UserAccountAggregateManager()));

//Build create user account aggregate command with name "foo bar"
var aggregateId = UserAccountId.New;
var createUserAccountCommand = new CreateUserAccountCommand(aggregateId, "foo bar");

//Send command, this is equivalent to command.publish() in other cqrs frameworks

//tell the aggregateManager to change the name of the aggregate root to "foo bar baz"
var changeNameCommand = new UserAccountChangeNameCommand(aggregateId, "foo bar baz");

Assumptions About Akkatecture Developers

It would be ideal if you have some experience in domain driven design, cqrs, and event sourcing. It would also be beneficial for you to be familiar with actor systems, akka.net, and the extensibility points that akka gives you through hocon configuration. If you need to skill up on akka.net, check out petabridge's akka-bootcamp. If you are already familiar with akka.net, go through the walkthrough and you would have covered most of the concepts that this framework offers.

Status of Akkatecture

Akkatecture is still in development. The goal of this projects first version is to provide you with the neccassary building blocks to build out your own cqrs and event sourced application without having to think of the implementation details of akka.net coupled with CQRS and event sourcing. Right now Akkatecture is focussed on developing the story for projection rebuilding. Projection rebuilding is a crucial feature that will lend Akkatecture to a version 1.0.0 release.


Code - If you want to contribute to the framework, do so on the dev branch and submit a PR.

Documentation - Akkatecture's documentation source is here, if you have any suggestions or improvements that can be made to them.

All contributions big or small are greatly appreciated!

Useful Resources

There are many different authoritative sources that prescribe best practices when building these kinds of systems that Akkatecture models. Here are a few articles and resources that can give you a good foundational grounding on the concepts used extensively in this project.

Domain-Driven Design
CQRS & Event sourcing
Eventual consistency
Video Content


Doing domain driven design in a distributed scenario is quite tricky. And even more so when you add cqrs and event sourcing style mechanics to your business domain. Akka.net gives you powerful ways to co-ordinate and organise your business rules by using actors and message passing, which can be done by sending messages through location transparent addresses (or references). The major benefits of using akka.net is that we can isolate our domain models into actors where it makes sense, in Akkatecture's case, an actor = aggregate root, this design decision is done because actors are inherently consistent between message handles, which is very much the same as aggregate roots in domain driven design. There is a high impedance match when you impose the actor model onto domain driven design, because actors can only guarantee their own internal state's consistency just like aggregate roots which maintain their own consistency boundary. Modelling aggregates as actors in the actor model is highly congruent.

Akkatecture gives you a set of opinionated generic constructs that you can use to wire up your application so that you can focus on your main task, modelling and codifying your business domain.

Akka.net gives us a wealth of good APIs out of the box that can be used to build entire systems out of. It also has a decent ecosystem and community for support. Akkatecture is also of the opinion that commands translate well semantically in actor systems since telling commands is a form of message passing that fits well into the actor model paradigm.


Akkatecture uses the methods of Keep A Changelog to keep track of features or functionality that has been added, changed, deprecated, removed, fixed, or patched for security reasons. The changelog also serves as a source of truth for the project's release notes.

Prerelease and Nightly Builds

Prerelease and nightly builds are not currently available. Please check back for updates soon from the maintainers at AfterLutz!

Prerelease feeds and nightly feeds (called alpha feeds in this project). Provide the most up to date packages for the project. Roughly speaking the prerelease feed is the most up to date packages that reflect master, and the nightly feed reflects the most up to packages derived from the dev branch. In other words, alpha feed is less stable than the prerelease feed but gets the features and fixes first. The access to the feeds:

Prerelease Feed - This is the Azure Artifacts URL, and this is the NuGet feed URL.

Nightly Feed - - This is the Azure Artifacts URL, and this is the NuGet feed URL.


  • Akka.NET - The project which AKkatecture builds ontop of, without akka.net, Akkatecture wouldnt exist.
  • EventFlow - Akkatecture has adapted the api surface from event flow to work in the akka actor world.
  • Nact - For giving us basis to write our documentation. Powered by gatsbyjs.


The MIT License (MIT)

Copyright (c) 2018 - 2021 Lutando Ngqakaza


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.8.0 2,869 6/20/2023
0.8.0-beta001 124 4/26/2023
0.7.1 463 6/27/2022
0.6.3 1,515 4/10/2020
0.6.2 581 3/18/2020
0.6.1 574 12/23/2019
0.6.0 526 11/10/2019
0.5.1 592 9/2/2019
0.5.0 656 8/18/2019
0.4.6 584 7/27/2019
0.4.5 683 5/15/2019
0.4.4 617 5/9/2019
0.4.3 700 4/28/2019
0.4.2 707 3/8/2019
0.4.1 731 1/22/2019
0.4.0 731 1/15/2019
0.3.0 761 11/11/2018
0.1.5 816 9/15/2018
0.1.4 786 9/12/2018
0.1.3 976 5/23/2018
0.1.2 933 5/20/2018
0.1.1 1,031 5/14/2018
0.0.25 1,016 5/13/2018
0.0.24 981 5/9/2018
0.0.23 990 5/9/2018
0.0.22 948 5/8/2018
0.0.21 977 5/8/2018
0.0.20 1,020 5/8/2018
0.0.2 600 7/16/2019
0.0.1 605 7/16/2019

Externally Updated