Onboarding experience

[Falanwe]

The following is a work-in progress proposal for the installation experience of a development Stormancer cluster

Stormancer local server installation experience

Prerequisites

You need a version of the Dotnet SDK installed on your computer

Tool Installation

First you need to install the Stormancer Dotnet tool.
To install it to the current folder, run

dotnet tool install Sormancer.CLI

You can use the --global argument to install it globally instead of for your current folder, and specify a specific version with the --version argument.

dotnet tool install --global Stormancer.CLI --version 5.3.3

Tou can find a list of all published versions at https://www.nuget.org/packages/Stormancer.CLI

Local server setup

To setup your Stormancer local server, just run

dotnet tool run stormancer setup

This will ask you to login to stormancer.com to configure your cluster's security, then will create configuratin files appropriate for most development scenarios.

This will create the following files in the current folder
-bootstrapper.config.json: This file includes location for working directories of the stormancer cluster, as well as references to the Stormancer cluster plugins to use in the latest version.
-default.json: this file contains the configuration of you development node

Additional arguments can be provided to customize your Installation

--directory

The directory to install your stormancer development cluster in
default value is .

--no-security

Disable security features, exempting you from connecting to an identity provider

--identity-provider

You can specify a custom identity provider to secure your cluster (syntax to be determined)

--node-count

You can specify a custom node count to test your applications in a multi-node environement. All nodes will still run in the same process
Node configuration files will be named default-i, with i ranging from 1 to the number of nodes specified
Default value is 1

Starting your cluster

To start your cluster, in the cluster folder, simply run the command

dotnet tool run stormancer start

Managing your cluster

To manage the cluster, open your browser to the page http://localhost:(port_to_determine) while the cluster is running. This website will ask you to log in using the identity provider of your choice (by default stormancer.com)

Starting your cluster as a service

To register your Stormancer cluster as a background service and start it, run the command

dotnet tool run stormancer setup service