Ticket #113 : Add eventmesh documentation

Author: habarthierry-hue

default.ps1

@@ -72,6 +72,10 @@ task publishEventMeshService {
 	exec { dotnet publish $source_dir\EventMesh\FaasNet.EventMesh.Service\FaasNet.EventMesh.Service.csproj -c $config -o $result_dir\eventMeshService }
 }
 
+task publishEventMeshCLI {
+	exec { dotnet publish $source_dir\EventMesh\FaasNet.EventMeshCTL.CLI\FaasNet.EventMeshCTL.CLI.csproj -c $config -o $result_dir\eventMeshCLI }
+}
+
 task deployEventMeshService {
 	exec { sc.exe create "EventMesh Service" binpath="$result_dir\eventMeshService\FaasNet.EventMesh.Service.exe --contentRoot $result_dir\eventMeshService" }
 }

docs/documentation/eventmesh/cli.md

@@ -0,0 +1,116 @@
+# Command-line interface
+
+`FaasNet.EventMeshCTL.CLI.exe` is the CLI tool that ships with EventMeshServer. It supports a wide range of operations, mostly administrative in nature.
+This includes
+
+* Access to cluster status.
+* Client and VPN management.
+* Manage plugins.
+
+## Add Virtual Private Network (VPN)
+
+**Command**
+
+`add_vpn`
+
+**Description**
+
+Add one Virtual Private Network (VPN).
+
+**Options**
+
+| Option    | Description  | Default value |
+| --------  | ------------ | ------------- |
+| -n/--name | VPN name     | default       |
+
+
+## Get all Virtual Private Network (VPN)
+
+**Command**
+
+`get_all_vpn`
+
+**Description**
+
+Display all the VPN.
+
+## Add client
+
+**Command**
+
+`add_client`
+
+**Description**
+
+Add one client.
+
+**Options**
+
+| Option                                   | Description          | Default value |
+| ---------------------------------------- | -------------------- | ------------- |
+| -v/--vpn                                 | VPN name             | default       |
+| -id/--identifier <LOGIN>                 | Client identifier    | clientId      |
+| -p/--publish_enabled <PUBLISH>           | Can publish messages | True          |
+| -s/--subscription_enabled <SUBSCRIPTION> | Can subscribe        | True          |
+
+## Display cluster status
+
+**Command**
+
+`cluster_status`
+
+**Description**
+
+Display cluster status.
+
+## Get plugins
+
+**Command**
+
+`get_plugins`
+
+**Description**
+
+Display all plugins.
+
+## Enable plugin
+
+**Command**
+
+`enable_plugin`
+
+**Description**
+
+Enable one plugin.
+
+**Options**
+
+| Option    | Description | Default value |
+| --------- | ----------- | ------------- |
+| -n/--name | Plugin name |               |
+
+## Disable plugin
+
+**Command**
+
+`disable_plugin`
+
+**Description**
+
+Disable one plugin.
+
+**Options**
+
+| Option    | Description | Default value |
+| --------- | ----------- | ------------- |
+| -n/--name | Plugin name |               |
+
+## Version
+
+**Command**
+
+`version`
+
+**Description**
+
+Display the CLI version.

docs/documentation/eventmesh/installclionwindows.md

@@ -0,0 +1,24 @@
+# Installing the EventMesh CLI on Windows
+
+This guide describes how EventMesh CLI can be installed and configured manually on Windows.
+
+The CLI is used to manage one local or remote instance of an EventMesh server.
+
+## Download zip
+
+Download the ZIP file [EventMeshCLI.zip](#) and extract its content into a new Directory.
+The windows account must have READ and WRITE access to this directory otherwise the configuration file cannot be updated or read.
+
+## Register the service
+
+Open the environment variable window and add the full path of this new directory into the `PATH` environment variable.
+
+Open a new command prompt and execute `FaasNet.EventMeshCTL.CLI.exe version`. If the version is displayed then the CLI is correctly installed.
+
+You can check if the EventMesh server is running on your local machine by executing this command `FaasNet.EventMeshCTL.CLI.exe cluster_status`.
+You should see at least one instance listening on the port 4000.
+
+```
+Current nodes
+Url=localhost, Port=4000
+```

docs/documentation/eventmesh/installserveronwindows.md

@@ -0,0 +1,31 @@
+# Installing on Windows Manually
+
+This guide describes how EventMesh server can be installed and configured manually on Windows.
+
+## Download zip
+
+Download the zip file [EventMeshServer.zip](TODO) and extract its content into a new directory.
+
+## Deploy the windows service
+
+As an administrator, open a command prompt and execute the following command. The parameter `$result_dir` must be replaced by the full path of the new directory.
+The windows account used to run the windows service must have READ and WRITE access to this new directory otherwise the key-value storage cannot be created.
+
+```
+sc.exe create "EventMesh Service" binpath="$result_dir\FaasNet.EventMesh.Service.exe --contentRoot $result_dir"
+```
+
+In the same command prompt. Execute the command below to start the windows service.
+
+```
+sc.exe start "EventMesh Service"
+```
+
+The windows service can be stopped like this :
+
+```
+sc.exe stop "EventMesh Service"
+```
+
+After some minutes, the EventMesh server is launched and is listening on the port 4000.
+Now, the CLI can be downloaded to manage the local EventMesh server.

docs/documentation/eventmesh/pluginamqp.md

@@ -0,0 +1,2 @@
+# AMQP1.0 protocol plugin
+

docs/documentation/eventmesh/plugins.md

@@ -0,0 +1,34 @@
+# Plugins
+
+EventMesh server supports plugins. Plugins extend core functionality in a variety of ways: 
+* Support more protocols.
+* Support more sink connectors. A sink connector consumes records from an event store or message broker and stream the data events to the EventMesh server.
+
+## Install a plugin
+
+A plugin can manually be installed :
+1. Download the zip file.
+2. Extract its content.
+3. Based on the nature of the plugin, move the folder into the appropriate sub-folder of the local EventMesh server.
+   * If the plugin supports an additional protocol then the sub-folder is `protocolPlugins`.
+   * If the plugin supports a new sink connector then the sub-folder is `sinkPlugins`.
+
+## Enable a plugin
+
+Once the plugin is installed, open a command prompt and execute the command `FaasNet.EventMeshCTL.CLI.exe  enable_plugin -n=<PLUGIN_NAME>` to enable the plugin.
+
+If the plugin is successfully enabled then a success message is displayed.
+
+The EventMesh server must be restarted to take into consideration the new activated plugins.
+
+## Supported plugins
+
+The table below lists plugins
+
+| Plugin name                                 | Folder           | Description                                         |
+| ------------------------------------------- | ---------------- | --------------------------------------------------- |
+| [ProtocolAmqp](pluginamqp.md)               | protocolPlugins  | Support AMQP1.0 protocol                            |
+| [ProtocolWebsocket](pluginwebsocket.md)     | protocolPlugins  | Support WebSocket protocol                          |
+| [SinkAMQP](pluginsinkamqp.md)               | sinkPlugins      | Consume records from AMQP server                    |
+| [SinkKafka](pluginsinkkafka.md)             | sinkPlugins      | Consume records from KAFKA server                   |
+| [SinkVpnBridge](pluginsinkvpnbridge.md)     | sinkPlugins      | Consume records from Virtual Private Network bridge |

docs/documentation/eventmesh/pluginsinkamqp.md

@@ -0,0 +1,2 @@
+# Websocket protocol plugin
+