Add `Member Roles` doc #5742

eaba · 2022-03-22T13:38:32Z

Aaronontheweb · 2022-03-22T13:44:31Z

docs/articles/clustering/node-roles.md

@@ -0,0 +1,24 @@
+---
+uid: node-roles
+title: Node Roles


Should be called "Member Roles"

Aaronontheweb · 2022-03-22T13:44:46Z

docs/articles/clustering/node-roles.md

+
+Not all nodes of a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching. Choosing which actors to start on each node, for example cluster-aware routers, can take node roles into account to achieve this distribution of responsibilities.
+
+The node roles are defined in the configuration property named `akka.cluster.roles` and typically defined in the start script as a system property or environment variable.


Show an example

Aaronontheweb · 2022-03-22T13:45:28Z

docs/articles/clustering/node-roles.md

+
+# Node Roles
+
+Not all nodes of a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching. Choosing which actors to start on each node, for example cluster-aware routers, can take node roles into account to achieve this distribution of responsibilities.


Need to expand this:

Why are roles important?

How are they used elsewhere in different parts of Akka.Cluster (this should be a bulleted list) ?

What do they allow end-users to do?

Aaronontheweb · 2022-03-22T16:36:03Z

docs/articles/clustering/member-roles.md

+title: Member Roles
+---
+
+# Why Are Roles Important


Title: Member Roles

Aaronontheweb · 2022-03-22T16:36:12Z

docs/articles/clustering/member-roles.md

+
+# Why Are Roles Important
+
+A cluster can have multiple Akka.NET applications in it, "roles" help to distinguish different Akka.NET applications within a cluster!


Diagram would be useful here

Aaronontheweb · 2022-03-22T16:36:37Z

docs/articles/clustering/member-roles.md

+Not all Akka.NET applications in a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching. 
+Choosing which actors to start on each node, for example cluster-aware routers, can take member roles into account to achieve this distribution of responsibilities.
+
+# Usage


Move this to right after your opening sentence in the document, drop the #Usage

Aaronontheweb · 2022-03-22T16:37:10Z

docs/articles/clustering/member-roles.md

+and typically defined in the start script as a system property or environment variable.
+
+```
+var settings = ClusterShardingSettings


Wrong thing. This is showing how roles can be consumed from Akka.Cluster sharding. Has nothing to do with how they're defined in Akka.Cluster.

Aaronontheweb · 2022-03-22T16:38:09Z

docs/articles/clustering/member-roles.md

+    .WithRole(Environment.GetEnvironmentVariable("ROLE"));
+```
+
+The roles are part of the membership information in `MemberEvent` that you can subscribe to. The roles of the local cluster member are available from the `SelfMember` and that can be used for conditionally starting certain actors:


## How to Use Role Information in Akka.NET ### Programming Against Akka.Cluster Events {rest of your language here} ### Akka.Cluster.Sharding {example} ### `DistributedPubSub` {example} ### `DData`

ClusterSingleton would be good too.

Aaronontheweb · 2022-03-23T13:19:17Z

docs/articles/clustering/member-roles.md

+}
+```
+
+### Akka.Cluster.Sharding


Need to make all headers consistent - either code formatted or regular text, not a blend of both

Aaronontheweb · 2022-03-23T13:19:36Z

docs/articles/clustering/member-roles.md

+	cluster {
+    roles = ["worker", "notifier", "credit", "storage"]
+    singleton {
+			role = "credit"


And what does this mean for Cluster Singleton?

Aaronontheweb · 2022-03-23T13:19:45Z

docs/articles/clustering/member-roles.md

+	cluster {
+    roles = ["worker", "notifier", "credit", "storage"]
+    distributed-data {
+			role = "storage"


And what does this do for DData?

Aaronontheweb · 2022-03-23T13:19:54Z

docs/articles/clustering/member-roles.md

+	cluster {
+    roles = ["worker", "notifier", "credit", "storage"]
+    pub-sub {
+			role = "notifier"


And what does this do for DistributedPubSub?

Aaronontheweb · 2022-03-23T13:20:04Z

docs/articles/clustering/member-roles.md

+	cluster {
+    roles = ["worker", "notifier", "credit", "storage"]
+    sharding {
+			role = "worker"


And what does this do for Akka.Cluster.Sharding?

Aaronontheweb · 2022-03-23T13:30:20Z

docs/articles/clustering/member-roles.md

 ### `DistributedPubSub`

+Start the mediator on members tagged with this role. All members are used if undefined or empty.


Mediator will send messages to all nodes tagged with this role, otherwise all members will receive Mediator gossip.

Aaronontheweb · 2022-03-23T13:31:06Z

docs/articles/clustering/member-roles.md

 ### `ClusterSingleton`

+Singleton among the nodes tagged with specified role. If the role is not specified it's a singleton among all nodes in the cluster.


Specifies which nodes might host a specific singleton - if the role is not specified than any node can, in theory, host a singleton.

Aaronontheweb · 2022-03-23T13:31:29Z

Need to add a clustered router example too

Aaronontheweb · 2022-03-23T14:06:16Z

docs/articles/clustering/member-roles.md

+
+A cluster can have multiple Akka.NET applications in it, "roles" help to distinguish different Akka.NET applications within a cluster!
+Not all Akka.NET applications in a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching.
+Choosing which actors to start on each node, for example cluster-aware routers, can take member roles into account to achieve this distribution of responsibilities.


Something needs to be said about usage of roles being a best practice. There isn't a good reason not to do it. Just come out and say this along the following lines:

Roles make it very easy to direct traffic to the right areas in your cluster;

Even if you only have a single type of node in your cluster, you should still use roles for it so you can leverage this infrastructure as your cluster expands in the future; and

They add zero overhead in any conceivable way.

Aaronontheweb · 2022-03-23T14:07:08Z

docs/articles/clustering/member-roles.md

+
+# Member Roles
+
+![cluster roles](/images/cluster-roles.png)


this image should probably be moved into a "cluster" sub folder, rather than the root images folder. Don't want to clutter that up.

Aaronontheweb · 2022-03-23T14:07:36Z

docs/articles/clustering/member-roles.md

+Not all Akka.NET applications in a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching.
+Choosing which actors to start on each node, for example cluster-aware routers, can take member roles into account to achieve this distribution of responsibilities.
+
+# How to Use Role Information in Akka.NET


"How to Use Roles"

Aaronontheweb · 2022-03-23T14:07:57Z

docs/articles/clustering/member-roles.md

+  }
+}
+```
+# Programming Against Akka.Cluster Events


"Using Roles Within Your Cluster"

Aaronontheweb · 2022-03-23T14:08:36Z

docs/articles/clustering/member-roles.md

+}
+```
+
+# Akka.Cluster.Sharding


Should really be H2, not H1 - same for all of these

Aaronontheweb · 2022-03-23T14:11:18Z

docs/articles/clustering/toc.yml

+  href: split-brain-resolver.md
+- name: Member Roles


Move this much closer to the top - as this is a critical, fundamental concept to clustering.

Also, link to this page from the cluster overview early on.

* Reference `member-roles.md` in `cluster-overview.md` * Moved `member-roles.md` much closer to the top

* Adde more detail

Aaronontheweb · 2022-03-24T14:25:56Z

docs/articles/clustering/member-roles.md

+
+## Cluster-Aware Router
+
+The major benefit of Akka.Cluster is that you can scale out your actor system to more nodes as load on the system increases - in other words, during peak period, Akka.Cluster can scale out your, for instance, order processor. 


You need to talk about this primarily in the context of roles here, not just the cluster

Aaronontheweb

LGTM

Aaronontheweb · 2022-03-24T18:14:28Z

docs/articles/clustering/cluster-overview.md

@@ -236,6 +236,7 @@ A node might also exit the cluster gracefully, preventing it from being marked a
 <iframe width="560" height="315" src="https://www.youtube.com/embed/mUTKvGyxbOA" frameborder="0" allowfullscreen></iframe>
 <!-- markdownlint-enable MD033 -->

+* [Cluster Member Roles](member-roles.md)


Also, should probably add a comment earlier in the actual literature of this page about cluster roles, rather than just slapping a link in the "additional resources" section - introduce the context of what a role is sooner while we're introducing other Akka.Cluster concepts.

Aaronontheweb · 2022-03-24T18:15:40Z

docs/articles/clustering/member-roles.md

+Specifying cluster role(s) is a best practice; you don't want an application that requires less computational power running and consuming resources meant for a mission-critical and resource-intensive application.
+Even if you only have a single type of node in your cluster, you should still use roles for it so you can leverage this infrastructure as your cluster expands in the future; and they add zero overhead in any conceivable way.
+
+# How To Configure Cluster Role


* Moved the `akka core` configuration page into `modules`` (#5664) * Fix link issue with `xref` (#5666) Co-authored-by: Aaron Stannard <aaron@petabridge.com> * [Docs]: Fix Metadata Reference (#5668) * Turn on `ProduceReferenceAssembly` * Add `ProduceReferenceAssembly` to `common.props` * Fix build failures in Akka.FSharp * Revert `<ProduceReferenceAssembly>$(ProduceReferenceAssembly)</ProduceReferenceAssembly>` added to affected projects because it already exists in `common.props' * Resolved invalid links (#5669) * Check for possible broken documentation by failing on DocFX warning (#5542) * Add --warningsAsErrors flag to DocFX * Add check in AzDo pr validation yaml * Use windows image for docfx test * Fix build script name * disable incremental builds for DocFx Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Make sure DocFX warning check step only executed in PR (#5674) * Make sure DocFX warning check step only executed in PR * Add run_if parameter to template Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> * [Docs] Improve coordinated shutdown doc hygiene (#5677) * Extract hocon settings * Import coordinated shutdown phases using docfx code reference * Correct the usage of `integration` (#5679) * Improve code reference hygiene with exisiting code block (#5680) * Updated developement scenario (#5533) * Updated developement scenario * Fix markdown linting * Fix linting * Fix linting * Fix linting * Fix linting * Fix linting * Improve `toc.yml` for all sections * Console deployment * Sleep for 5 seconds * Add ASP.NET Core page * Fix startup issue * Fix typo * Fix linting issue * Fix trailing space * Added Headless Service * Fixed typo * Fix linting * * Resolves #5533 * Resolves #5533 * Fix linting * update solution projects * Fix invalid path * Solution project auto updated itself Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Fix ORSet.Merge with AddDeltaOperation takes too long to complete (#5686) * Fix ORSet.Merge with AddDeltaOperation takes too long to complete * Make sure that insertion is still correct after the changes * Increase update timeout setting Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> * Make PipeTo ConfigureAwait() optional (#5684) * Remove ConfigureAwait() from PipeTo() * Remove ConfigureAwait() from PipeTo() * Add ConfigureAwait back to PipeTo, make it configurable instead * Update API Approval list * Add function overload for backward compatibility * Update API Approval list Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> * Optimize PipeTo ConfigureAwait call (#5688) * Optimize PipeTo ConfigureAwait call * Inverse the double negative parameter Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> * Fixed broken toc.yml (#5694) * Fix Serialization documentation discoverability (#5699) * Fix Serialization documentation discoverability * Rename Akka.IO * fixed name of serializer id table Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Call `base.AfterAll()` to kill TestKit ActorSystem (#5705) Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> * Fix confusing logging when receiving gossip from unknown (#5706) * Reorder Source/FlowWithContext type parameters (#5648) Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Add Stateful methods for circuitbreaker (#5650) * Add Stateful methods for circuitbreaker * api docs * fix api docs Co-authored-by: Gregorius Soedharmo <arkatufus@yahoo.com> Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Update RELEASE_NOTES.md for 1.4.34 release (#5707) Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> * Added placeholder for 1.4.35 (#5709) * Fix PersistenceId Query and Sqlite unit tests (#5715) * Fix PersistenceId Query and Sqlite unit tests * Fix unit test assert * [DocFx] custom Akka.NET theme (#5659) * added updated Akka.NET DocFx theme * added "Show and Tell" page * added v1.5 notes * fix video embeds on mobile (#5719) * Fixed `IActorRef` leak inside `EventStream` (#5720) * reproduced #5717 Reproduced `IActorRef` leak inside the `EventStream` * cleaned up the `EventBusUnsubscriber` * close #5719 - cleaned up `EventStream` subscription management * added API approval For `Obsolete` attribute. * need to capture more data on why failures happen * harden bugfix5717specs * supress InvalidOperationException in xUnit OutputLogger (#5722) * Bump Google.Protobuf from 3.17.3 to 3.19.4 (#5555) Bumps [Google.Protobuf](https://github.com/protocolbuffers/protobuf) from 3.17.3 to 3.19.4. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/master/generate_changelog.py) - [Commits](protocolbuffers/protobuf@v3.17.3...v3.19.4) --- updated-dependencies: - dependency-name: Google.Protobuf dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add MapMaterializedValue for Source/Flow WithContext (#5711) Co-authored-by: Gregorius Soedharmo <arkatufus@yahoo.com> * close #5728 fix `ActorSystemSetup.And` (#5729) * Update RELEASE_NOTES.md for 1.4.35 release (#5726) * Update RELEASE_NOTES.md for 1.4.35 release * Update RELEASE_NOTES.md with the latest changes * v1.4.36 placeholder for nightlies (#5732) * Update PersistAsync to match docs. (#5736) This is supposed to be the example for persistAsync, but it doesn't get used at all. https://getakka.net/articles/persistence/event-sourcing.html#relaxed-local-consistency-requirements-and-high-throughput-use-cases I changed the code to match what is here: https://doc.akka.io/docs/akka/current/persistence.html#relaxed-local-consistency-requirements-and-high-throughput-use-cases * [DI] DI fails to throw an exception when DI tried to create an actor with missing constructor parameter (#5735) * Add bug spec for DI bug * Fix unit test to reflect the correct failure behaviour * Fix spelling (#5745) * Lock cspell on version `5.18.5` (#5744) * Lock cspell on version `5.18.5` * Use version `5.17.0` Co-authored-by: Aaron Stannard <aaron@petabridge.com> * cleanup XUnit TestKit output logger (#5741) * marked `EventBusUnsubscriber` messages as `INoSerializationVerificationNeeded` (#5743) Eliminates issues with some `MinimalActorRef` actors subscribing to the `EventStream` when `akka.actor.serialize-messages = on`. * Fix MSBuild does not copy xunit.runner dlls correctly (#5747) * Add documentation on how to override serializer ids. (#5749) * Add `Member Roles` doc (#5742) * Add `Node Roles` doc Co-authored-by: Aaron Stannard <aaron@petabridge.com> * [DOCS]: Add `Examples` section to Akka.NET Doc (#5739) * Add initial commit * Fix linting and spell checks * Update examples * Fix lint issues * Fix spell check - American English * fix examples href * Update page title * Updated page with more examples * Update examples.md * Fix lint and markdown errors. * Fix docs conflict * Fix blanks * Delete examples.md.orig Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Bump Hyperion to 0.12.2 (#5805) * Bump Hyperion to 0.12.2 * Add HyperionSerializerSettings immutable modifier methods * Fix unit tests * Fix leaky coordinated shutdown (#5816) * Fix CoordinatedShutdown infinite loop * Fix circular reference memory leak * Fix memory leak * Couple of fixes for the TcpConnection (#5817) * Fix TcpConnection error handling * Try not to get stopped by death pact before Unregistration is complete * Update RELEASE_NOTES.md for 1.4.36 release (#5820) * Revert changes that are unrelated to the memory leak (#5822) * Be more explicit that a node is shutting down as it was marked as DOWN (#5821) Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Change the failure log inside `AllEventPublisher` from Debug to Error (#5835) * Fix LeaseProvider instance Activator exception handling (#5838) * Make ActorSystemImpl.Abort skip the CoordinatedShutdown check (#5839) * Bump Microsoft.Data.SQLite from 5.0.11 to 6.0.4 (#5837) Bumps [Microsoft.Data.SQLite](https://github.com/dotnet/efcore) from 5.0.11 to 6.0.4. - [Release notes](https://github.com/dotnet/efcore/releases) - [Commits](dotnet/efcore@v5.0.11...v6.0.4) --- updated-dependencies: - dependency-name: Microsoft.Data.SQLite dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update RELEASE_NOTES.md for 1.4.37 release (#5841) * Add specs to test disallow-unsafe-type (#5746) * Add spec to test disallow-unsafe-type * Fix Hyperion disallow-unsafe-type spec * move from ApprovalTests to Verify for api tests (#5846) * approved to verified * move to verify * Update CoreAPISpec.cs * Update Akka.API.Tests.csproj * Update Akka.API.Tests.csproj * Update CoreAPISpec.cs * Bump FsCheckVersion from 2.16.3 to 2.16.4 (#5724) Bumps `FsCheckVersion` from 2.16.3 to 2.16.4. Updates `FsCheck` from 2.16.3 to 2.16.4 - [Release notes](https://github.com/fsharp/FsCheck/releases) - [Changelog](https://github.com/fscheck/FsCheck/blob/master/FsCheck%20Release%20Notes.md) - [Commits](fscheck/FsCheck@2.16.3...2.16.4) Updates `FsCheck.Xunit` from 2.16.3 to 2.16.4 - [Release notes](https://github.com/fsharp/FsCheck/releases) - [Changelog](https://github.com/fscheck/FsCheck/blob/master/FsCheck%20Release%20Notes.md) - [Commits](fscheck/FsCheck@2.16.3...2.16.4) --- updated-dependencies: - dependency-name: FsCheck dependency-type: direct:production update-type: version-update:semver-patch - dependency-name: FsCheck.Xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix Persistence.TCK specs (#5849) * DeleteMessagesFailure message should log its failure stack trace * Make JournalSpec facts overridable * Make error reporting standardized. * change `dev` version number to 1.5-x (#5856) * Zbynek001 sharding update2 (#5857) * Add Dropped to Akka.Actor (migrated partially from akka/akka#27160) Log Dropped from DeadLetterListener * Logging of UnhandledMessage (migrated from akka/akka#28414) * make use of the existing logging of dead letter also for UnhandledMessage Supress ActorSelectionMessage with DeadLetterSuppression (migrated from akka/akka#28341) * for example the Cluster InitJoin message is marked with DeadLetterSuppression but was anyway logged because sent with actorSelection * for other WrappedMessage than ActorSelectionMessage we shouldn't unwrap and publish the inner in SuppressedDeadLetter because that might loose some information * therefore those are silenced in the DeadLetterListener instead Better deadLetter logging of wrapped messages (migrated from akka/akka#28253) * MessageBuffer implementations * TestKit logger with prefix * sharding update * sharding tests * sharding multinode tests * api approval * replace sqlite with MemoryJournalShared and local snapshot store * tests * snapshot inmem * backwards compatible PersistenceId for PersistentShardCoordinator * test fix * SnapshotStoreProxy & MemorySnapshotStoreShared * test snapshot store switched to shared inmem * ExternalShardAllocationStrategy & tests * ExternalShardAllocationStrategy API approval * test timing fix * review comments addressed * IEquatable removed for singleton messages * test fixes * cleanup * test cleanup * protobuf generated * cleanup * cleanup * Race condition in DeprecatedSupervisionSpec fixed (migrated from akka/akka#29914) * cleanup * Small clarification of recovery strategy in config (migrated from akka/akka#30167) * Resolve snapshot check skipped for some events (migrated from akka/akka#30226) * additional sharding messages serialization, tests * api approval update * disable durable storage on ShardRegionSpec * extend timeout for ExternalShardAllocationSpec * naming conventions * missing readonly added, updated syntax * renaming conventions * Defer coordinator stop until region graceful stop has completed (migrated from akka/akka#30338) * sharding: actively signal 'region stopped' to the coordinator (migrated from akka/akka#30402) * racy test fix * racy test verbose logging * test update * merge fix * sharding ddata coordinator switch to ReadMajorityPlus/WriteMajorityPlus * more logs to debug tests * more logs * fix MultiNodeClusterSpec default timeouts * revert additional logs * override single-expect-default only for sharding tests * revert unrelated protobuf serializers * Fix StartEntitySpec instability (migrated from akka/akka#30537) The old logic allowed a race condition where the 'StartEntity' from the test arrived at the ShardRegion before the termination of the actor did, causing it to ignore the `StartEntity`. * Quieter logging for ShardCoordinator initialization (migrated from akka/akka#30488) Log the first retry on 'info', then 'warning', and finally 'error' * reduce default write-majority-plus for sharding (migrated from akka/akka#30328) * merge fix * rebalance log fix * fixed compilation error from rebase * switch RememberEntitiesShardIdExtractorChangeSpec from ddata to persistence * disable durable storage on PersistentShardingMigrationSpec * clean up leveldb configuration * fix XML-DOC warnings Co-authored-by: zbynek001 <zbynek001@gmail.com> Co-authored-by: Gregorius Soedharmo <arkatufus@yahoo.com> * Bump Swashbuckle.AspNetCore from 6.2.3 to 6.3.0 (#5848) Bumps [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) from 6.2.3 to 6.3.0. - [Release notes](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/releases) - [Commits](domaindrivendev/Swashbuckle.AspNetCore@v6.2.3...v6.3.0) --- updated-dependencies: - dependency-name: Swashbuckle.AspNetCore dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * cleaned up some allocations and styling (#5855) * fix sharding recovery (#5863) * Update MNTR to 1.1.1 and update build script to suit (#5866) * GroupBy fixes (#5874) * Target incrementalist against v1.4 branch for v1.4 * Update MNTR to 1.1.1 and update build script to suit (#5867) (cherry picked from commit 2b4267e) * GroupBy pulls upstream when a substream materialization is waiting * Cancel GroupBy when all substreams cancel * Allow GroupBy to recreate already closed substreams * Fixes GroupBy does not invoke decider * Avoids memory being retained for GroupBy * Revert v1.4 merge * Fix markdownlint error Co-authored-by: Aaron Stannard <aaron@petabridge.com> Co-authored-by: Gregorius Soedharmo <arkatufus@yahoo.com> * Fix Source.ActorRef not completing (#5875) * Fix typo in `akka.remote.dot-netty.ssl.certificate` (#5895) * enable `ChannelTaskScheduler` to work inside Akka.Cluster without causing errors inside `/system` actors (#5861) (#5920) * close #5498 enable `ChannelTaskScheduler` to work inside Akka.Cluster without causing errors inside `/system` actors * fix `HeartbeatSender` * cleaned up SBR internals (style) * cleaned up some comments * asynchronously attempt to acquire `Cluster` inside SBR * fixed SBR compilation * Update SplitBrainResolver.cs * subscribe on PreStart * added .NET 6 dual targeting to all assemblies (#5926) * added .NET 6 dual targeting to all assemblies have not added and .NET 6-specific code yet, just added support for it in the build system * adding verify files per-runtime * added all .NET 6 files * moved files to their own folder * added all Verified files * Renamed method `SetHandler` accepting both callbacks to `SetHandlers` (#5931) * Rewrite actor ref sink as a graph stage (#5930) Co-authored-by: Aaron Stannard <aaron@petabridge.com> * Post-merge cleanup * Update API verify list * Post-merge fix and update API verify list * Fix XML doc * Post merge fix, docs * Fix XML Doc * Post merge fix * Post merge fix Co-authored-by: Ebere Abanonu <eaba@users.noreply.github.com> Co-authored-by: Aaron Stannard <aaron@petabridge.com> Co-authored-by: Gregorius Soedharmo <gregorius.soedharmo@petabridge.com> Co-authored-by: Ismael Hamed <1279846+ismaelhamed@users.noreply.github.com> Co-authored-by: Drew <laingas@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Adrian Leonhard <adrianleonhard@gmail.com> Co-authored-by: Simon Cropp <simon.cropp@gmail.com> Co-authored-by: zbynek001 <zbynek001@gmail.com>

Add Node Roles doc

a81c258

Aaronontheweb requested changes Mar 22, 2022

View reviewed changes

eaba and others added 2 commits March 22, 2022 16:29

Merge branch 'dev' into cluster_roles

4563c2c

Update documentation

5de627d

eaba changed the title ~~Add Node Roles doc~~ Add Member Roles doc Mar 22, 2022

Aaronontheweb reviewed Mar 22, 2022

View reviewed changes

docs/articles/clustering/member-roles.md Outdated

title: Member Roles

---

# Why Are Roles Important

Copy link

Member

Aaronontheweb Mar 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Title: Member Roles

Aaronontheweb reviewed Mar 22, 2022

View reviewed changes

Fixed lint errors

210ae39

Aaronontheweb reviewed Mar 22, 2022

View reviewed changes

eaba and others added 4 commits March 22, 2022 18:36

Merge branch 'dev' into cluster_roles

d7de54a

Added diagram image

8529d77

replaced cluster roles diagram with a simpler version

876a5b4

Added cluster config example for other cluster modules

76ff75a

Aaronontheweb reviewed Mar 23, 2022

View reviewed changes

Add more detail on what the roles do

a2374d4

Aaronontheweb reviewed Mar 23, 2022

View reviewed changes

eaba and others added 3 commits March 23, 2022 14:33

Added more detail

400bec0

Merge branch 'dev' into cluster_roles

66a4b6f

Fix tabbing

82a4380

Aaronontheweb added docs akka-cluster labels Mar 23, 2022

Aaronontheweb reviewed Mar 23, 2022

View reviewed changes

eaba added 5 commits March 23, 2022 18:01

Attempt formating fix

6fee097

Moved cluster-roles.png to cluster folder under images

dbd5dd5

* Fix heading with H2

aad9f44

* Reference `member-roles.md` in `cluster-overview.md` * Moved `member-roles.md` much closer to the top

Fix hard tabs

854d723

* created new image

a300b06

* Adde more detail

Aaronontheweb reviewed Mar 24, 2022

View reviewed changes

eaba and others added 4 commits March 24, 2022 18:21

Updated documentation

3bc1939

Merge branch 'dev' into cluster_roles

ae9a01f

Fix linting issues

fca18c5

Fix linting issue

d16ea43

eaba marked this pull request as ready for review March 24, 2022 18:12

Aaronontheweb approved these changes Mar 24, 2022

View reviewed changes

Aaronontheweb added 2 commits March 24, 2022 13:16

Update cluster-overview.md

c8ab363

Update member-roles.md

43d8791

Aaronontheweb enabled auto-merge (squash) March 24, 2022 18:17

Aaronontheweb disabled auto-merge March 24, 2022 18:17

Aaronontheweb enabled auto-merge (squash) March 24, 2022 18:17

Aaronontheweb merged commit b365c06 into akkadotnet:dev Mar 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Member Roles` doc #5742

Add `Member Roles` doc #5742

eaba commented Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 22, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb commented Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 23, 2022

Aaronontheweb Mar 24, 2022

Aaronontheweb left a comment

Aaronontheweb Mar 24, 2022

Aaronontheweb Mar 24, 2022

Aaronontheweb Mar 24, 2022


		Not all nodes of a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching. Choosing which actors to start on each node, for example cluster-aware routers, can take node roles into account to achieve this distribution of responsibilities.

		The node roles are defined in the configuration property named `akka.cluster.roles` and typically defined in the start script as a system property or environment variable.


		# Node Roles

		Not all nodes of a cluster need to perform the same function. For example, there might be one sub-set which runs the web front-end, one which runs the data access layer and one for the number-crunching. Choosing which actors to start on each node, for example cluster-aware routers, can take node roles into account to achieve this distribution of responsibilities.


		# Why Are Roles Important

		A cluster can have multiple Akka.NET applications in it, "roles" help to distinguish different Akka.NET applications within a cluster!

		### `DistributedPubSub`

		Start the mediator on members tagged with this role. All members are used if undefined or empty.

		### `ClusterSingleton`

		Singleton among the nodes tagged with specified role. If the role is not specified it's a singleton among all nodes in the cluster.


		## Cluster-Aware Router

		The major benefit of Akka.Cluster is that you can scale out your actor system to more nodes as load on the system increases - in other words, during peak period, Akka.Cluster can scale out your, for instance, order processor.

Add Member Roles doc #5742

Add Member Roles doc #5742

Conversation

eaba commented Mar 22, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaronontheweb commented Mar 23, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaronontheweb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `Member Roles` doc #5742

Add `Member Roles` doc #5742