Skip to content
Snippets Groups Projects
Commit 0789f8a6 authored by Hugo's avatar Hugo
Browse files

small fixes

parent 111b3b7d
Branches
Tags
No related merge requests found
Pipeline #12013 passed
Stage: build
Stage: deploy
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 1498 additions and 536 deletions
docs/ecolyo/application/deploy.md
+ 4
− 4
View file @ 0789f8a6
......@@ -31,12 +31,12 @@ Now you should see the name of your distribution in the list.
### Setup your distribution
Start Up Updating the packages list by typing :
Start updating the packages list by typing :
```
sudo apt update
```
Install the nodejs using the apt package manager
Install nodejs using the apt package manager
```
sudo apt install
......@@ -87,7 +87,7 @@ First open a new session and connect to the distant host **192.168.62.31**. Don'
## Deploy Ecolyo
### Deploy on Alpha
### Deploy on Alpha - Scaleway
#### Windows
......@@ -112,4 +112,4 @@ To deploy on the llle-build environment, you'll have to drag and drop your build
#### Linux
From your current branch, run ```yarn build``` then ```sudo yarn deploy_dev``` to instantly deploy your working branch on the latest tagged Ecolyo container registry.
From your current branch, run ```yarn build``` then ```sudo yarn deploy_dev``` to instantly deploy your working branch on the latest tagged Ecolyo-dev container registry.
docs/ecolyo/getting_started/launch_local_application.md
+ 12
− 15
View file @ 0789f8a6
......@@ -48,7 +48,7 @@ If this file is not empty, you can simply add the follwing lines to it:
"window.zoomLevel": 0,
```
## Installation of the projet
## Installation of the project
### Installation of node modules
......@@ -73,11 +73,6 @@ If the application starts successfully you should obtain the following message:
Once the application is started, run the easy-cozy stack with docker.
!!! info "Fix webpack error on cozy script"
**Deprecated** Updated cozy-script lib
To fix it launch the following command in node_modules/cozy-script folder:
` yarn add webpack `
### Run easy-cozy dev stack
The dev stack will contain the cozy-stack with some default applications and konnectors and allow you to run this stack locally.
......@@ -98,7 +93,7 @@ docker pull registry.forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/co
#### On windows
Launch the stack will following command:
Launch the stack with the following command:
```
yarn winstack
......@@ -110,6 +105,7 @@ A Powershell window will open. Wait until the success message:
> To exit, press ^C
Once successfull you can launch your local cozy with following url: [Cozy local url](http://cozy.tools:8080/)
Local database can also be consulted at the following url: [Cozy local DB](http://localhost:5984/_utils/)
#### On Linux
......@@ -126,12 +122,13 @@ Wait until the success message:
> To exit, press ^C
Once successfull you can launch your local cozy with following url [Cozy local url](http://cozy.tools:8080/) and connect with the password '**cozy**'.
Local database can also be consulted at the following url: [Cozy local DB](http://localhost:5984/_utils/)
## Import moke data
!!! info "Requirement"
Your dev stack should be running to import the moke data
!!! info "Requirement"
Your dev stack should be running to import the moke data
First install ACH using yarn :
......@@ -142,7 +139,7 @@ yarn global add cozy-ach
Next create the "config.js" file base on the "config.template.js"
!!! info ""
You can change the period of data generated by changing the following lines:
You can change the period of data generated by changing the following lines:
```
const startingdate = DateTime.local()
......@@ -155,7 +152,7 @@ You can change the period of data generated by changing the following lines:
Just replace -120 by the value needed
Next launch the script **createDayDataFiles.js** available into **scripts** folder
Next launch the script **createDayDataFiles.js** available into the **scripts** folder
```
cd scripts
......@@ -171,7 +168,7 @@ cd scripts
```
!!! info ""
You'll be prompted for a cozysessid, you can get it in the web console ; in the 'application' tab, look for the cookies and just copy the cozysessid value.
You'll be prompted for a cozysessid, you can get it in the web console ; in the `application` tab, look for the cookies and just copy the cozysessid value.
A new browser windows will open and asking you approval to import data. Just click on **Approve**
......@@ -180,16 +177,16 @@ Finally your data is loaded in the Ecolyo Application !
## Simulate konnectors connection
!!! info "Requirement"
Your dev stack should be running to import data needed to simulate konnectors connection
Your dev stack should be running to import data needed to simulate konnectors connection
When using local environment, konnectors are not able to connect.
To simulate the connection you can use the script **createConnection.js** available in **scripts** folder.
First update the authorization and cookie information from the "config.js" file (if not create just create it from the "config.template.js" file):
First update the authorization and cookie information from the "config.js" file (if not created just create it from the "config.template.js" file):
```
const authorization =
'Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
'Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
const cookie =
'cozysessid=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```
......
docs/ecolyo/index.md
+ 1
− 1
View file @ 0789f8a6
LLLE - Ecolyo is a multi-fluid application solution towards users of the grand lyon metropolis to monitor and optimize their energy consumption.
Ecolyo is a multi-fluid application solution towards users of the grand lyon metropolis to monitor and optimize their energy consumption.
!!! info ""
If you are a new developper tasked to work on this project, check the [setup your environment](./getting_started/setup_your_environment.md) and [launch the application on local](./getting_started/launch_local_application.md) to start the application.
......
docs/ecolyo/konnectors/egl.md
+ 1
− 6
View file @ 0789f8a6
......@@ -131,10 +131,5 @@ If you're looking for more information about the API, checkout the [complete API
| processData | Parse data. Remove existing data from DB using hydrateAndFilter, store filtered data and return the list of filtered data |
| authenticate | Authentication method. Requires login, password, baseUrl and ApiAuthKey. |
| storeData | Save data in the right doctype db and prevent duplicated keys |
| format | Format data for DB storage and remove bad data |
| processYearAgregation | |
| processMonthlyAgregation | |
| groupBy | |
| reduceYearFunction | |
| reduceMonthFunction | |
| format | Format data for DB storage and remove bad data (former "T" typeagregats remain in response even if the data was added later, leading to duplicated data) |
| resetInProgressAggregatedData | Function handling special case.The temporary aggregated data need to be remove in order for the most recent one te be saved. Ex for com.grandlyon.egl.year : `{ load: 76.712, year: 2020, ... }` need to be replace by `{ load: 82.212, year: 2020, ... }` after egl data reprocess |
docs/ecolyo/konnectors/enedis.md
+ 1
− 1
View file @ 0789f8a6
......@@ -7,7 +7,7 @@ You should also check Cozy's official documentations for konnectors :
## Enedis Konnector
The Oauth protocol does not take place in the konnector code, therefore it is also important to take a look at the [proxy](../../proxy/description.md) to fully understand all the interactions that will be told below.
The Oauth protocol does not take place in the konnector code, therefore it is also important to take a look at the [proxy](../../proxy/description.md) documentation to fully understand all the interactions that will be told below.
All the actions performed by the stack are targetted from pre-registered paramaters, here is the list of all parameters needed by the stack to perform the Oauth protocol and allow the konnector to fetch data.
On its first launch, following the Oauth Client Connect authentification.
......
docs/ecolyo/project_architecture/architecture.md
+ 1
− 1
View file @ 0789f8a6
## Libraries
For this project, we use libraries below:
For this project, we use the libraries below:
###React
......
docs/proxy/monitoring.md 0 → 100644
+ 10
− 0
View file @ 0789f8a6
All logs printed by the Proxy are read and translated into statistics on a grafana dashboard.
!!! info "Grafana"
[scaleway monitoring](https://grafana.self-data.alpha.grandlyon.com/)
[production](https://oauth-logs.cozycloud.cc/d/xSRhz8fMk/cozy-oauth-proxy?orgId=1&refresh=5s)
Thanks to this monitoring system, the team is able to understand when something goes wrong with a konnector if the konnector or the proxy are to blame or if an issue was coming from Enedis or Grdf.
Learn more about how it works [here](https://forge.grandlyon.com/web-et-numerique/llle_project/logs-monitoring).
mkdocs.yml
+ 1
− 0
View file @ 0789f8a6
......@@ -79,6 +79,7 @@ nav:
- Profile Type: ecolyo/functionalities/profile_type.md
- Proxy:
- Description: proxy/description.md
- Monitoring: proxy/monitoring.md
- Use cases:
- Enedis: proxy/use_cases/enedis.md
- Grdf Adict: proxy/use_cases/grdfadict.md
site/404.html
+ 671
− 237
View file @ 0789f8a6
This diff is collapsed.
site/assets/images/favicon.png
+ 0
− 0
View replaced file @ 111b3b7d View file @ 0789f8a6
site/assets/images/favicon.png

1.83 KiB | W: | H:

site/assets/images/favicon.png

521 B | W: | H:

site/assets/images/favicon.png
site/assets/images/favicon.png
site/assets/images/favicon.png
site/assets/images/favicon.png
  • 2-up
  • Swipe
  • Onion skin
site/index.html
+ 687
− 250
View file @ 0789f8a6
This diff is collapsed.
site/search/search_index.json
+ 1
− 1
View file @ 0789f8a6
Source diff could not be displayed: it is too large. Options to address this: view the blob.
site/sitemap.xml
+ 108
− 20
View file @ 0789f8a6
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-01-04</lastmod>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
\ No newline at end of file
site/sitemap.xml.gz
+ 0
− 0
View file @ 0789f8a6
No preview for this file type
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment