Petabridge.Cmd.Cluster.Sharding
1.4.3
Prefix Reserved
dotnet add package Petabridge.Cmd.Cluster.Sharding --version 1.4.3
NuGet\Install-Package Petabridge.Cmd.Cluster.Sharding -Version 1.4.3
<PackageReference Include="Petabridge.Cmd.Cluster.Sharding" Version="1.4.3" />
paket add Petabridge.Cmd.Cluster.Sharding --version 1.4.3
#r "nuget: Petabridge.Cmd.Cluster.Sharding, 1.4.3"
// Install Petabridge.Cmd.Cluster.Sharding as a Cake Addin #addin nuget:?package=Petabridge.Cmd.Cluster.Sharding&version=1.4.3 // Install Petabridge.Cmd.Cluster.Sharding as a Cake Tool #tool nuget:?package=Petabridge.Cmd.Cluster.Sharding&version=1.4.3
Petabridge.Cmd
Petabridge.Cmd is a command-line interface (CLI) for Akka.NET, designed to help monitor and manage live ActorSystem
s through simple commands.
- Website: https://cmd.petabridge.com/
- Chat: 🗣️ https://discord.gg/kgsruUF889
- Issue Tracker: 🪲 https://github.com/petabridge/petabridge.cmd-issues
Use
After you've installed the Petabridge.Cmd.Host into your Akka.NET application and the pbm
client onto your workstation, you can connect to your server, download any commands that are defined on them, and begin executing them right away!
Some examples:
Print Current Actor Hierarchy
pbm actor hierarchy
Print Current Cluster Status
Only works when Petabridge.Cmd.Cluster is installed.
pbm cluster show
Down All Unreachable Nodes in Cluster
Only works when Petabridge.Cmd.Cluster is installed.
pbm cluster down-unreachable
There are dozens of built-in Petabridge.Cmd commands and it's quite easy to build your own custom ones!
Installation
In order to use Petabridge.Cmd you must follow our installation instructions and get both a server and a client up and running.
Default Ports and Hostnames
By default, Petabridge.Cmd.Host will open the following ports for accepting TCP connections from pbm
clients:
- Port: 9110
- Host: All addresses (0.0.0.0)
Server and Command Pallette Installation
Before we can use the Petabridge.Cmd client (pbm
) we need to install the Petabridge.Cmd server inside one of our Akka.NET applications - which we can do by installing the Petabridge.Cmd.Host NuGet package:
dotnet add package Petabridge.Cmd.Host
Next, we just need to hook this up into our ActorSystem
.
Using Akka.Hosting (Recommended)
Akka.Hosting is a HOCON-less approach to configuring and instantiating Akka.NET applications, and it's the easiest way to configure Petabridge.Cmd inside your ActorSystem
- using the AddPetabridgeCmd
method found in the Petabridge.Cmd.Host package:
using var host = await (new HostBuilder().ConfigureServices((context, collection) =>
{
collection.AddAkka("PbmSys", builder =>
{
builder.WithRemoting("localhost", 29909)
.WithClustering(new ClusterOptions(){ SeedNodes = new[]{ "akka.tcp://PbmSys@localhost:29909" }})
.AddPetabridgeCmd(
new PetabridgeCmdOptions(){ Host = "localhost", Port = 8222}, // optional - customize pbm bindings
cmd =>
{
cmd.RegisterCommandPalette(new RemoteCommands());
cmd.RegisterCommandPalette(ClusterCommands.Instance);
});
});
}).StartAsync());
You can register all of your CommandPalette instances using the builder and Petabridge.Cmd will be started up automatically. All HOCON values can still be used to configure binding addresses.
Manually Starting Petabridge.Cmd
In order to active Petabridge.Cmd.Host inside your Akka.NET application, you need to make the following call inside your application (if you're not using Akka.Hosting:)
private static void Main(string[] args)
{
using (var a = ActorSystem.Create("Foo"))
{
var cmd = PetabridgeCmd.Get(a);
cmd.Start();
a.WhenTerminated.Wait();
}
}
Registering Additional Command Palettes
Petabridge.Cmd ships with an additional set of commands for managing Akka.Cluster applications, which are not loaded by default. After installing the Petabridge.Cmd.Cluster
NuGet package into your host application, you an register the commands with the PetabridgeCmd
plugin via the following syntax:
using (var a = ActorSystem.Create("webcrawler"))
{
var cmd = PetabridgeCmd.Get(a);
cmd.RegisterCommandPalette(ClusterCommands.Instance); // non-default command palette
cmd.Start();
a.WhenTerminated.Wait();
}
Or when using Akka.Hosting:
collection.AddAkka("PbmSys", builder =>
{
builder.WithRemoting("localhost", 29909)
.WithClustering(new ClusterOptions(){ SeedNodes = new[]{ "akka.tcp://PbmSys@localhost:29909" }})
.AddPetabridgeCmd(
new PetabridgeCmdOptions(){ Host = "localhost", Port = 8222}, // optional - customize pbm bindings
cmd =>
{
cmd.RegisterCommandPalette(new RemoteCommands());
cmd.RegisterCommandPalette(ClusterCommands.Instance); // non-default command palette
});
});
Client Installation
The easiest way to install Petabridge.Cmd's client is to install the pbm
.NET global tool:
> dotnet tool install --global pbm
To see full details about how the Petabridge.Cmd client and server connectivity model works, please see "How Petabridge.Cmd Works."
Need Help?
To get help with Petabridge.Cmd you can file a bug on our issue tracker or contact us in Discord.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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. |
-
.NETStandard 2.0
- Akka.Cluster.Sharding (>= 1.5.25)
- Petabridge.Cmd.Host (>= 1.4.3)
-
net6.0
- Akka.Cluster.Sharding (>= 1.5.25)
- Petabridge.Cmd.Host (>= 1.4.3)
NuGet packages (5)
Showing the top 5 NuGet packages that depend on Petabridge.Cmd.Cluster.Sharding:
Package | Downloads |
---|---|
FAkka.Shared
Package Description |
|
FAkka.Seed.7.0
Package Description |
|
FAkka.Server.Linux
Package Description |
|
FAkka.FAkka.Seed.7.0
Package Description |
|
FAkka.Shared.Linux
Package Description |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Petabridge.Cmd.Cluster.Sharding:
Repository | Stars |
---|---|
petabridge/akkadotnet-code-samples
Akka.NET professional reference code samples
|
|
Aaronontheweb/InMemoryCQRSReplication
Akka.NET Reference Architecture - CQRS + Sharding + In-Memory Replication
|
Version | Downloads | Last updated |
---|---|---|
1.4.3 | 7,472 | 6/17/2024 |
1.4.2 | 576 | 6/11/2024 |
1.4.1 | 10,238 | 3/18/2024 |
1.4.0 | 11,383 | 1/12/2024 |
1.3.3 | 250 | 1/10/2024 |
1.3.2 | 27,574 | 7/18/2023 |
1.3.1 | 15,264 | 5/4/2023 |
1.3.0 | 13,929 | 3/3/2023 |
1.3.0-beta1 | 219 | 3/1/2023 |
1.2.2 | 7,698 | 1/19/2023 |
1.2.1 | 1,209 | 12/19/2022 |
1.2.0 | 1,720 | 11/18/2022 |
1.1.4 | 158 | 7/17/2023 |
1.1.3 | 10,135 | 10/20/2022 |
1.1.2 | 5,475 | 9/28/2022 |
1.1.1 | 541 | 9/23/2022 |
1.1.0 | 14,002 | 6/9/2022 |
1.0.2 | 40,020 | 11/16/2021 |
1.0.1 | 10,948 | 8/3/2021 |
1.0.0 | 1,918 | 7/26/2021 |
0.8.5 | 14,120 | 5/3/2021 |
0.8.4 | 345 | 4/30/2021 |
0.8.3 | 5,875 | 3/18/2021 |
0.8.2 | 11,504 | 11/24/2020 |
0.8.1 | 9,083 | 11/16/2020 |
0.8.0 | 30,702 | 3/11/2020 |
0.8.0-rc2 | 338 | 3/10/2020 |
0.8.0-rc1 | 377 | 3/3/2020 |
0.7.1-beta | 3,012 | 3/3/2020 |
0.7.0-beta | 3,638 | 10/3/2019 |
0.6.3-beta | 2,634 | 7/30/2019 |
0.6.2-beta | 1,268 | 6/19/2019 |
0.6.1-beta | 881 | 5/19/2019 |
0.6.0-beta | 1,095 | 5/9/2019 |
0.5.0-beta | 1,332 | 3/6/2019 |
Update [Akka.NET to v1.5.25](https://github.com/akkadotnet/akka.net/releases/tag/1.5.25).