Ticket #63: Write documentation

Author: habarthierry-hue

README.md

@@ -10,27 +10,27 @@ For project documentation, please visit [docs](https://simpleidserver.github.io/
 
 | Command                     | Description                             |
 | --------------------------  | --------------------------------------- |
-| psake publishHelmAndWebsite | Publish Helm Charts and the website     |
-
-## Packages
-
-|                         			 						|      																															  																					|																																								|																																								|
-| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `FaasNet.Runtime` 			 			     			| [![MyGet (dev)](https://img.shields.io/myget/advance-ict/v/FaasNet.Runtime.svg)](https://www.myget.org/feed/advance-ict/package/nuget/FaasNet.Runtime)								              				| [![NuGet](https://img.shields.io/nuget/v/FaasNet.Runtime.svg)](https://nuget.org/packages/FaasNet.Runtime) 													| [![NuGet](https://img.shields.io/nuget/dt/FaasNet.Runtime.svg)](https://nuget.org/packages/FaasNet.Runtime) 													|
-| `FaasNet.Templates` 			 			     			| [![MyGet (dev)](https://img.shields.io/myget/advance-ict/v/FaasNet.Templates.svg)](https://www.myget.org/feed/advance-ict/package/nuget/FaasNet.Templates)								           				| [![NuGet](https://img.shields.io/nuget/v/FaasNet.Templates.svg)](https://nuget.org/packages/FaasNet.Templates)												| [![NuGet](https://img.shields.io/nuget/dt/FaasNet.Templates.svg)](https://nuget.org/packages/FaasNet.Templates) 												|
+| psake publishWebsite 		  | Publish website                         |
+| psake publishDockerCI       | Build and publish docker images         |
+| psake packTemplate          | Build template package                  |
 
 ## How to release ?
 
 1. Build the Docker images and publish them into the Hub.
 
 ```
-psake builderDockerImage
+psake publishDockerCI
 ```
 
-2. Build the website and helm package and publish them into the GITHUB page.
+2. Build and publish the website.
 
 ```
-psake publishHelmAndWebsite
+psake publishWebsite
 ```
 
-3. Create and publish the tag release.
+3. Create and publish the tag release.
+4. Build the template and upload the Nuget package.
+
+```
+psake packTemplate
+```

default.ps1

@@ -12,17 +12,13 @@ properties {
     $versionSuffix = @{ $true = "--version-suffix=$($suffix)"; $false = ""}[$suffix -ne ""]
 }
 
-
-task default -depends local
-task local -depends compile, test
-task ci -depends clean, release, local, pack, publish
-
 # DEV tasks
 task packDev -depends clean, packNoSuffix, packTemplate
 task dockerDev -depends clean, publishDockerDev
 
 # CI tasks
 task dockerCI -depends clean, publishDockerCI
+task ci -depends clean, test, pack, publishCLI
 
 task clean {
 	rd "$source_dir\artifacts" -recurse -force  -ErrorAction SilentlyContinue | out-null
@@ -47,56 +43,6 @@ task compile -depends clean {
     exec { dotnet build .\EventMesh.sln -c $config --version-suffix=$buildSuffix }
 }
 
-task publishHelmAndWebsite {
-	exec { git checkout gh-pages }
-	exec { git rm -r . }
-	exec { git checkout HEAD -- .gitignore }
-	exec { git add . }
-	exec { git commit -m "Remove" }
-	exec { git checkout master }
-	exec { helm package ./helm -d ./docs/charts }
-	exec { Copy-item "./helm/Chart.yaml" -Destination "./docs/charts" }
-	exec { helm repo index ./docs/charts }
-	exec { Remove-Item "./docs/charts/Chart.yaml" }
-	rd "$base_dir\docs\obj" -recurse -force  -ErrorAction SilentlyContinue | out-null
-	exec { docfx ./docs/docfx.json }
-	exec { git add . }
-	exec { git commit -m "Publish helm" }
-	exec { Copy-item -Force -Recurse -Verbose "./docs/_site/*" -Destination "." }
-	exec { git checkout gh-pages --merge }
-	exec { git add . }
-	exec { git commit -m "Update Documentation" }
-	exec { git rebase -i HEAD~2 }
-	exec { git push origin gh-pages }
-	exec { git checkout master }
-}
-
-task initLocalKubernetes {
-	exec { kubectl apply -f ./kubernetes/faas-namespace.yml }
-    exec { kubectl apply -f ./kubernetes/run-mssql.yml --namespace=faas }
-    exec { kubectl apply -f ./kubernetes/mssql-internal-svc.yml --namespace=faas }
-    exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume.yml --namespace=faas }
-    exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume-claim.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/run-faas-kubernetes.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/faas-kubernetes-svc.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/run-prometheus.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/faas-prometheus-svc.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/run-faas-gateway.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/faas-gateway-svc.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/run-website.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/faas-website-svc.yml --namespace=faas }
-}
-
-task initDevKubernetes {
-	exec { kubectl apply -f ./kubernetes/faas-namespace.yml }
-    exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume.yml --namespace=faas }
-    exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume-claim.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/run-prometheus.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/faas-prometheus-svc.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/run-faas-kubernetes.yml --namespace=faas }
-	exec { kubectl apply -f ./kubernetes/faas-kubernetes-external-svc.yml --namespace=faas }	
-}
-
 # Publish assets
 task publishCLI {
 	exec { dotnet publish $source_dir\FaasNet.CLI\FaasNet.CLI.csproj -c $config -o $result_dir\cli }
@@ -112,6 +58,7 @@ task publishDocker {
 
 # Pack
 task pack -depends release, compile {
+	exec { dotnet pack $source_dir\FaasNet.Function\FaasNet.Function.csproj -c $config --no-build $versionSuffix --output $result_dir }
 	exec { dotnet pack $source_dir\FaasNet.Runtime\FaasNet.Runtime.csproj -c $config --no-build $versionSuffix --output $result_dir }
 	exec { dotnet pack $source_dir\EventMesh.Runtime\EventMesh.Runtime.csproj -c $config --no-build $versionSuffix --output $result_dir }
 	exec { dotnet pack $source_dir\EventMesh.Runtime.AMQP\EventMesh.Runtime.AMQP.csproj -c $config --no-build $versionSuffix --output $result_dir }
@@ -120,6 +67,7 @@ task pack -depends release, compile {
 }
 
 task packNoSuffix -depends release, compile {
+	exec { dotnet pack $source_dir\FaasNet.Function\FaasNet.Function.csproj -c $config --output $result_dir }
 	exec { dotnet pack $source_dir\FaasNet.Runtime\FaasNet.Runtime.csproj -c $config --output $result_dir }
 	exec { dotnet pack $source_dir\EventMesh.Runtime\EventMesh.Runtime.csproj -c $config --output $result_dir }
 	exec { dotnet pack $source_dir\EventMesh.Runtime.AMQP\EventMesh.Runtime.AMQP.csproj -c $config --output $result_dir }
@@ -187,6 +135,28 @@ task deployEventMeshServerKafka {
 	exec { kubectl apply -f ./kubernetes/eventmeshserver.kafka.yml --namespace=faas }	
 }
 
+task deployServerlessWorkflow {
+	exec { kubectl apply -f ./kubernetes/serverlessworkflow.yml --namespace=faas }	
+}
+
+# Publish
+task publishWebsite {
+	exec { git checkout gh-pages }
+	exec { git rm -r . }
+	exec { git checkout HEAD -- .gitignore }
+	exec { git add . }
+	exec { git commit -m "Remove" }
+	exec { git checkout master }
+	exec { docfx ./docs/docfx.json }
+	exec { Copy-item -Force -Recurse -Verbose "./docs/_site/*" -Destination "." }
+	exec { git checkout gh-pages --merge }
+	exec { git add . }
+	exec { git commit -m "Update Documentation" }
+	exec { git rebase -i HEAD~2 }
+	exec { git push origin gh-pages }
+	exec { git checkout master }
+}
+
 task test {	
     Push-Location -Path $base_dir\tests\EventMesh.Runtime.Tests
 

docs/documentation/bigpicture/images/bigpicture1.png

@@ -1,12 +1,11 @@
 # Introduction
 
-The FaasNet architecture is made of 6 blocks :
+FaasNet architecture is made of five blocks :
 
-* **Function** : Each function is deployed into one or more Kubernetes PODs.
-* **Gateway** : Expose operations to the angular website & CLI. They are used to manage the lifecyle of the functions and workflows.
-* **Monitoring** : Prometheus product is configured by default in order to monitor the published functions.
-* **Website** : Portal application which can be used by developers to manage the functions.
-* **CLI** : Command Line Interface (CLI) which can be used by developers to manage the functions.
-* **FaasNet Kubernetes** : API used by the gateway to interact with Kubernetes.
+* **Function** : One function can be deployed into one or more Kubernetes PODs.
+* **Gateway** : Expose operations to the portal and CLI. They can be used to perform administrative tasks on `function`, `serverless workflow` and `EventMesh server`.
+* **Monitoring** : Prometheus product is configured by default to monitor published functions.
+* **Portal/CLI** : Used by developers to perform administrative tasks.
+* **Kubernetes** : Execute operations on Kubernetes like : deploying / removing functions.
 
 ![Big Picture](images/bigpicture1.png)

docs/documentation/bigpicture/index.md

@@ -1,13 +1,29 @@
 # Docker
 
+An EventMesh server can easily be installed with Kubernetes. There is one deployment file per type of message broker. Following chapters list the different possibilites.
+
+Whatever the deployment file chosen. By default, the EventMesh server is listening on TCP Port `30005` and a UI portal is available [here](http://localhost:30004).
+
 ## InMemory
 
-TODO
+An EventMesh server plugged with an InMemory message broker can be deployed like this :
+
+```
+kubectl apply -f https://raw.githubusercontent.com/simpleidserver/FaasNet/master/kubernetes/release/eventmeshserver.yml --namespace=faas
+```
 
 ## RabbitMQ
 
-TODO
+An EventMesh server plugged with RabbitMQ can be deployed like this :
+
+```
+kubectl apply -f https://raw.githubusercontent.com/simpleidserver/FaasNet/master/kubernetes/release/eventmeshserver.rabbitmq.yml --namespace=faas
+```
 
 ## Kafka
 
-TODO
+An EventMesh server plugged with Apache Kafka can be deployed like this :
+
+```
+kubectl apply -f https://raw.githubusercontent.com/simpleidserver/FaasNet/master/kubernetes/release/eventmeshserver.kafka.yml --namespace=faas
+```

docs/documentation/eventmesh/docker.md

@@ -16,7 +16,7 @@ The following files will be created :
 
 * *Startup.cs* and *Program.cs*: the application entry point.
 * *HelloWorldConfiguration.cs*: configuration properties of the function.
-* *FunctionHandler.cs*: contains the business logic. This class has one function which accepts one parameter and returns a JSON result. The input parameter has two distinct properties :
+* *FunctionHandler.cs*: contains the business logic. This class has one function with one parameter and returns a JSON result. The input parameter has two distinct properties :
 
   * Configuration: its value is coming from the gateway, it will be used to configure the behavior of the function for example : `ConnectionString` and `SQL Statement`.
   * Input: value passed by caller.