Skip to content

Commit ee1a6d8

Browse files
habarthierry-huehabarthierry-hue
committed
Ticket ## : Update documentation + fix Promotheus file "targets.json"
1 parent d336956 commit ee1a6d8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+298
-321
lines changed

‎FaasNet.sln‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FaasNet.Gateway.Core", "src
1515
EndProject
1616
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FaasNet.CLI", "src\FaasNet.CLI\FaasNet.CLI.csproj", "{EDDFD04B-B4F0-47A6-8FD3-628F3F542402}"
1717
EndProject
18-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FaasNet.Common", "src\FaasNet.Common\FaasNet.Common.csproj", "{8B02C02D-EF1A-4F48-A69D-DC8592D966B9}"
19-
EndProject
2018
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FaasNet.Website", "src\FaasNet.Website\FaasNet.Website.csproj", "{6B493287-F29B-4988-A21F-A32EF81DE717}"
2119
EndProject
2220
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FaasNet.Function", "src\FaasNet.Function\FaasNet.Function.csproj", "{EF3FCDDE-0BD4-4D8A-85C9-D7639CD29942}"
@@ -61,10 +59,6 @@ Global
6159
{EDDFD04B-B4F0-47A6-8FD3-628F3F542402}.Debug|Any CPU.Build.0 = Debug|Any CPU
6260
{EDDFD04B-B4F0-47A6-8FD3-628F3F542402}.Release|Any CPU.ActiveCfg = Release|Any CPU
6361
{EDDFD04B-B4F0-47A6-8FD3-628F3F542402}.Release|Any CPU.Build.0 = Release|Any CPU
64-
{8B02C02D-EF1A-4F48-A69D-DC8592D966B9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
65-
{8B02C02D-EF1A-4F48-A69D-DC8592D966B9}.Debug|Any CPU.Build.0 = Debug|Any CPU
66-
{8B02C02D-EF1A-4F48-A69D-DC8592D966B9}.Release|Any CPU.ActiveCfg = Release|Any CPU
67-
{8B02C02D-EF1A-4F48-A69D-DC8592D966B9}.Release|Any CPU.Build.0 = Release|Any CPU
6862
{6B493287-F29B-4988-A21F-A32EF81DE717}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
6963
{6B493287-F29B-4988-A21F-A32EF81DE717}.Debug|Any CPU.Build.0 = Debug|Any CPU
7064
{6B493287-F29B-4988-A21F-A32EF81DE717}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -113,7 +107,6 @@ Global
113107
{2B6F7B44-91D5-44DD-8615-4EE8447F4839} = {B0C38F6D-3F83-458A-A493-428AB3DD9F85}
114108
{65DA8EDF-48A2-4AB5-B93A-6301718F1C1B} = {8D35E32C-AB12-44C8-8FAF-D9FF8CF805B7}
115109
{EDDFD04B-B4F0-47A6-8FD3-628F3F542402} = {B0C38F6D-3F83-458A-A493-428AB3DD9F85}
116-
{8B02C02D-EF1A-4F48-A69D-DC8592D966B9} = {1064A767-7322-4A14-BFD4-97FDD40E76B4}
117110
{6B493287-F29B-4988-A21F-A32EF81DE717} = {B0C38F6D-3F83-458A-A493-428AB3DD9F85}
118111
{EF3FCDDE-0BD4-4D8A-85C9-D7639CD29942} = {1064A767-7322-4A14-BFD4-97FDD40E76B4}
119112
{1FD1AA96-64C8-49B5-8B46-35E8BF82495B} = {E407AB8F-BDC8-4084-BE20-B4442CFE5EE9}

‎GatewayDockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ EXPOSE 8080
88

99
WORKDIR /App
1010

11-
ENTRYPOINT ["dotnet", "FaasNet.Gateway.Startup.dll"]
11+
ENTRYPOINT ["dotnet", "FaasNet.Gateway.SqlServer.Startup.dll"]

‎RuntimeDockerfile‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎default.ps1‎

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ task publish {
2121
exec { dotnet publish $source_dir\FaasNet.Function.GetSql\FaasNet.Function.GetSql.csproj -c $config -o $result_dir\services\RuntimeGetSql }
2222
exec { dotnet publish $source_dir\FaasNet.Function.Transform\FaasNet.Function.Transform.csproj -c $config -o $result_dir\services\RuntimeTransform }
2323
exec { dotnet publish $source_dir\FaasNet.Kubernetes\FaasNet.Kubernetes.csproj -c $config -o $result_dir\services\Kubernetes }
24-
# exec { dotnet publish $source_dir\FaasNet.Gateway.Startup\FaasNet.Gateway.Startup.csproj -c $config -o $result_dir\services\Gateway }
25-
# exec { dotnet publish $source_dir\FaasNet.CLI\FaasNet.CLI.csproj -c $config -o $result_dir\cli }
24+
exec { dotnet publish $source_dir\FaasNet.Gateway.SqlServer.Startup\FaasNet.Gateway.SqlServer.Startup.csproj -c $config -o $result_dir\services\Gateway }
25+
exec { dotnet publish $source_dir\FaasNet.CLI\FaasNet.CLI.csproj -c $config -o $result_dir\cli }
2626
}
2727

2828
task publishTemplate {
@@ -77,38 +77,34 @@ task publishHelmAndWebsite {
7777

7878
task buildLocalDockerImage -depends publish {
7979
exec { npm run docker --prefix $source_dir\FaasNet.Website }
80-
# exec { docker build -f RuntimeGetSqlDockerfile -t localhost:5000/faasgetsql . }
80+
exec { docker build -f RuntimeGetSqlDockerfile -t localhost:5000/faasgetsql . }
8181
exec { docker build -f RuntimeTransformDockerfile -t localhost:5000/faastransform . }
8282
exec { docker build -f KubernetesDockerfile -t localhost:5000/faaskubernetes . }
83-
# exec { docker build -f GatewayDockerfile -t localhost:5000/faasgateway . }
84-
# exec { docker build -f WebsiteDockerfile -t localhost:5000/faaswebsite . }
83+
exec { docker build -f GatewayDockerfile -t localhost:5000/faasgateway . }
84+
exec { docker build -f WebsiteDockerfile -t localhost:5000/faaswebsite . }
8585
exec { docker build -f PrometheusDockerfile -t localhost:5000/faasprometheus . }
86-
# exec { docker push localhost:5000/faasgetsql }
86+
exec { docker push localhost:5000/faasgetsql }
8787
exec { docker push localhost:5000/faastransform }
8888
exec { docker push localhost:5000/faaskubernetes }
89-
# exec { docker push localhost:5000/faasgateway }
90-
# exec { docker push localhost:5000/faaswebsite }
89+
exec { docker push localhost:5000/faasgateway }
90+
exec { docker push localhost:5000/faaswebsite }
9191
exec { docker push localhost:5000/faasprometheus }
9292
}
9393

9494
task initLocalKubernetes {
9595
exec { kubectl apply -f ./kubernetes/faas-namespace.yml }
9696
exec { kubectl apply -f ./kubernetes/run-mssql.yml --namespace=faas }
97-
exec { kubectl apply -f ./kubernetes/mssql-external-svc.yml --namespace=faas }
9897
exec { kubectl apply -f ./kubernetes/mssql-internal-svc.yml --namespace=faas }
9998
exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume.yml --namespace=faas }
10099
exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume-claim.yml --namespace=faas }
101100
exec { kubectl apply -f ./kubernetes/run-faas-kubernetes.yml --namespace=faas }
102101
exec { kubectl apply -f ./kubernetes/faas-kubernetes-svc.yml --namespace=faas }
103-
exec { kubectl apply -f ./kubernetes/faas-kubernetes-external-svc.yml --namespace=faas }
104102
exec { kubectl apply -f ./kubernetes/run-prometheus.yml --namespace=faas }
105-
exec { kubectl apply -f ./kubernetes/faas-external-prometheus-svc.yml --namespace=faas }
106-
# exec { kubectl apply -f ./kubernetes/run-faas-gateway.yml --namespace=faas }
107-
# exec { kubectl apply -f ./kubernetes/faas-gateway-svc.yml --namespace=faas }
108-
# exec { kubectl apply -f ./kubernetes/run-website.yml --namespace=faas }
109-
# exec { kubectl apply -f ./kubernetes/faas-website-svc.yml --namespace=faas }
110-
# exec { kubectl apply -f ./kubernetes/run-prometheus.yml --namespace=faas }
111-
# exec { kubectl apply -f ./kubernetes/faas-prometheus-svc.yml --namespace=faas }
103+
exec { kubectl apply -f ./kubernetes/faas-prometheus-svc.yml --namespace=faas }
104+
exec { kubectl apply -f ./kubernetes/run-faas-gateway.yml --namespace=faas }
105+
exec { kubectl apply -f ./kubernetes/faas-gateway-svc.yml --namespace=faas }
106+
exec { kubectl apply -f ./kubernetes/run-website.yml --namespace=faas }
107+
exec { kubectl apply -f ./kubernetes/faas-website-svc.yml --namespace=faas }
112108
}
113109

114110
task initDevKubernetes {
@@ -118,24 +114,23 @@ task initDevKubernetes {
118114
exec { kubectl apply -f ./kubernetes/run-prometheus.yml --namespace=faas }
119115
exec { kubectl apply -f ./kubernetes/faas-prometheus-svc.yml --namespace=faas }
120116
exec { kubectl apply -f ./kubernetes/run-faas-kubernetes.yml --namespace=faas }
121-
exec { kubectl apply -f ./kubernetes/faas-kubernetes-external-svc.yml --namespace=faas }
122-
117+
exec { kubectl apply -f ./kubernetes/faas-kubernetes-external-svc.yml --namespace=faas }
123118
}
124119

125120
task builderDockerImage -depends publish {
126121
exec { npm run docker --prefix $source_dir\FaasNet.Website }
127-
exec { docker build -f RuntimeGetSqlDockerfile -t simpleidserver/faasgetsql:0.0.3 . }
128-
exec { docker build -f RuntimeTransformDockerfile -t simpleidserver/faastransform:0.0.3 . }
129-
exec { docker build -f KubernetesDockerfile -t simpleidserver/faaskubernetes:0.0.3 . }
130-
exec { docker build -f GatewayDockerfile -t simpleidserver/faasgateway:0.0.3 . }
131-
exec { docker build -f WebsiteDockerfile -t simpleidserver/faaswebsite:0.0.3 . }
132-
exec { docker build -f PrometheusDockerfile -t simpleidserver/faasprometheus:0.0.3 . }
133-
exec { docker push simpleidserver/faasgetsql:0.0.3 }
134-
exec { docker push simpleidserver/faastransform:0.0.3 }
135-
exec { docker push simpleidserver/faaskubernetes:0.0.3 }
136-
exec { docker push simpleidserver/faasgateway:0.0.3 }
137-
exec { docker push simpleidserver/faaswebsite:0.0.3 }
138-
exec { docker push simpleidserver/faasprometheus:0.0.3 }
122+
exec { docker build -f RuntimeGetSqlDockerfile -t simpleidserver/faasgetsql:0.0.4 . }
123+
exec { docker build -f RuntimeTransformDockerfile -t simpleidserver/faastransform:0.0.4 . }
124+
exec { docker build -f KubernetesDockerfile -t simpleidserver/faaskubernetes:0.0.4 . }
125+
exec { docker build -f GatewayDockerfile -t simpleidserver/faasgateway:0.0.4 . }
126+
exec { docker build -f WebsiteDockerfile -t simpleidserver/faaswebsite:0.0.4 . }
127+
exec { docker build -f PrometheusDockerfile -t simpleidserver/faasprometheus:0.0.4 . }
128+
exec { docker push simpleidserver/faasgetsql:0.0.4 }
129+
exec { docker push simpleidserver/faastransform:0.0.4 }
130+
exec { docker push simpleidserver/faaskubernetes:0.0.4 }
131+
exec { docker push simpleidserver/faasgateway:0.0.4 }
132+
exec { docker push simpleidserver/faaswebsite:0.0.4 }
133+
exec { docker push simpleidserver/faasprometheus:0.0.4 }
139134
}
140135

141136
task pack -depends release, compile {

‎docs/documentation/bigpicture/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The FaasNet architecture is made of 6 blocks :
44

55
* **Function** : Each function is deployed into one or more Kubernetes PODs.
6-
* **Gateway** : Expose operations to the angular website & CLI. They are used to manage the lifecyle of the functions.
6+
* **Gateway** : Expose operations to the angular website & CLI. They are used to manage the lifecyle of the functions and workflows.
77
* **Monitoring** : Prometheus product is configured by default in order to monitor the published functions.
88
* **Website** : Portal application which can be used by developers to manage the functions.
99
* **CLI** : Command Line Interface (CLI) which can be used by developers to manage the functions.

‎docs/documentation/cli/configuration.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# FaasNet.CLI configuration
2+
3+
## Name
4+
5+
FaasNet.CLI configuration - Manage the configuration.
6+
7+
## Options
8+
9+
| Option | Arguments | Description |
10+
| -------------------------------------------- | -------------------------- | ----------------------- |
11+
| `FaasNet.CLI configuration -set gateway=URL` | `URL`: URL of the gateway. | Update the Gateway URL. |
12+
| `FaasNet.CLI configuration -get gateway` | | Get the Gateway URL |

‎docs/documentation/cli/function.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# FaasNet.CLI function
2+
3+
## Name
4+
5+
FaasNet.CLI function - Manage the lifecycle of a function : create, deploy, remove and invoke.
6+
7+
## Options
8+
9+
| Option | Arguments | Description |
10+
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- |
11+
| `FaasNet.CLI function -df <DIR>` | `DIR`: Visual studio solution directory. | Create a Docker File in the `DIR` |
12+
| `FaasNet.CLI function -db <DIR> <OTHER_ARGS>` | `DIR`: Visual studio solution directory.<br />`OTHER_ARGS`: Other arguments passed to the command line `docker build`. | Build the Docker File |
13+
| `FaasNet.CLI function -dp <DIR>` | `DIR`: Visual studio solution directory. | Push the docker image to the Docker hub |
14+
| `FaasNet.CLI function deploy -name <NAME> -image <IMAGE> -version <VERSION>` | `NAME`: Name of the function.<br />`IMAGE`: Name of the Docker image.<br /> `VERSION`: Version of the Docker image. | Deploy a function |
15+
| `FaasNet.CLI function -r <ID>` | `ID`: Identifier of the function. | Remove a function |
16+
| `FaasNet.CLI function invoke -id <ID> -configuration <CONFIGURATION> -input <INPT>` | `ID`: Identifier of the function.<br />`CONFIGURATION`: Configuration of the function.<br />`INPT`: Parameters passed to the function. | Invoke a function |
17+
| `FaasNet.CLI function configuration <ID>` | `ID`: Identifier of the function. | Get the configuration of the function |

‎docs/documentation/cli/overview.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CLI commands
2+
3+
The following commands are installed by default:
4+
5+
## Basic commands
6+
7+
* [function](function.md)
8+
* [configuration](configuration.md)

‎docs/documentation/functions/create.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,18 @@ FaasNet.CLI function -dp <IMAGENAME>
6969
Finally, execute the latest command line to deploy the function into the Gateway API. Replace the `FUNCTIONNAME` variable by the name of your function and replace the `IMAGENAME` variable by the name of your Docker image.
7070

7171
```
72-
FaasNet.CLI function deploy -name <FUNCTIONAME> -image <IMAGENAME>
72+
FaasNet.CLI function deploy -name <FUNCTIONAME> -image <IMAGENAME> -version latest
7373
```
7474

7575
# Execute a function
7676

7777
> [!WARNING]
7878
> Before you start, Make sure you have a function deployed in the Gateway API.
7979
80-
Execute the following command to invoke a function. Replace the `FUNCTIONNAME` variable by the name of your function.
80+
Execute the following command to invoke a function. Replace the `FUNCTIONID` variable by the identifier of your function.
8181

8282
```
83-
FaasNet.CLI function invoke -name <FUNCTIONNAME> -input {} -configuration {'firstName':'coucou'}
83+
FaasNet.CLI function invoke -id <FUNCTIONID> -input {} -configuration {'firstName':'coucou'}
8484
```
8585

8686
The following message is displayed

‎docs/documentation/functions/images/manage1.png‎

15.4 KB
Loading

0 commit comments

Comments
 (0)