Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • web-et-numerique/factory/llle_project/self-data-technical-doc
1 result
Show changes
Commits on Source (3)
Showing
with 45 additions and 44 deletions
......@@ -19,17 +19,17 @@ build_master:
- master
script:
- docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
- docker build -t registry.forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc .
- docker push registry.forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc
- docker build -t registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc .
- docker push registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc
deploy_master:
stage: deploy
tags:
- deploy
- deploy-alpha
only:
- master
script:
- cd /root/self-data-technical-doc
- docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
- docker-compose pull
- docker-compose up -d doc-self-data
- docker-compose up -d doc-self-data
......@@ -2,7 +2,7 @@ version: "3.3"
services:
self_data_docs:
image: registry.forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc:latest
image: registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc:latest
container_name: self_data_docs
restart: unless-stopped
logging:
......
# Local stack
![gitlab](../img/gitlab-logo.svg) [cozy-stack](https://forge.grandlyon.com/web-et-numerique/llle_project/cozy-stack)
![gitlab](../img/gitlab-logo.svg) [cozy-stack](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/cozy-stack)
## Why are we cloning the official repo ?
......
......@@ -23,7 +23,7 @@ docker-compose exec cozy ./cozy apps update home --domain "[name].cozy.self-data
docker-compose exec cozy ./cozy konnectors uninstall grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com"
grdfgrandlyon has been uninstalled
# cozy-stack konnectors install ${konn} --domain ${url}
docker-compose exec cozy ./cozy konnectors install grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com" git://forge.grandlyon.com/web-et-numerique/llle_project/grdf-adict-konnector.git#build
docker-compose exec cozy ./cozy konnectors install grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com" git://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-adict-konnector.git#build
grdfgrandlyon (0.1.5) has been installed on [name].cozy.self-data.alpha.grandlyon.com
```
......
......@@ -41,7 +41,7 @@ yarn deploy
In order to prevent manual action for deployment, a gitlab-runner has been configured to deploy every changes on the `dev` branch on our test [env](https://ecolyo.ecolyodemo.cozy.self-data.alpha.grandlyon.com/)
!!! info "cicd scripts"
You can find all scripts used in cicd jobs on the following [repository](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo-infra-scripts)
You can find all scripts used in cicd jobs on the following [repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo-infra-scripts)
## Deploy build-test branch to one Scaleway instance for testing
......@@ -67,7 +67,7 @@ You can deploy content of build branch into Cozy registry by using the cozy-app-
```sh
yarn cozy-app-publish \
--token $COZY_TOKEN \
--build-url https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/-/archive/build/ecolyo-build.tar.gz \
--build-url https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/-/archive/build/ecolyo-build.tar.gz \
--manual-version $VERSION_NUMBER \
--space $COZY_SPACE
```
......
......@@ -15,7 +15,7 @@ This will prevent anyone to push on the master branch, the only way to add code
- Retrieve the project on your computer, open a command line and execute.
```sh
git clone https://forge.grandlyon.com/web-et-numerique/llle.git
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo
```
- Create the development branch
......
......@@ -46,9 +46,9 @@ git push --follow-tags origin dev
:warning: Do not push with VS Code
5. Finally, add release notes in gitlab in your [project -> repository -> tags](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/-/tags) -> **edit release notes**
5. Finally, add release notes in gitlab in your [project -> repository -> tags](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/-/tags) -> **edit release notes**
You can copy paste the last changes in [CHANGELOG.MD](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/-/blob/dev/CHANGELOG.md)
You can copy paste the last changes in [CHANGELOG.MD](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/-/blob/dev/CHANGELOG.md)
### Annotated Tags
......
......@@ -8,11 +8,11 @@ To deploy ecolyo-agent application in a production environment, you need to crea
### docker-compose.yml
Example [here](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client/-/blob/dev/docker-compose.yml)
Example [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client/-/blob/dev/docker-compose.yml)
### site.conf
Find exemples [here](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client/-/tree/dev/nginx)
Find exemples [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client/-/tree/dev/nginx)
### .env
......@@ -29,7 +29,7 @@ SSL_CRT_FILE=cert.pem
SSL_KEY_FILE=key.pem
```
Complete with this example [here](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server/-/blob/dev/.env.template)
Complete with this example [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server/-/blob/dev/.env.template)
## Start the application
......
......@@ -4,7 +4,7 @@ This section will allow you to import the assets used in the newsletter from Eco
## Import assets
In the rec or prod server, in the folder `scripts`, there is the following script, named [`import-convert-assets.sh`](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client/-/blob/dev/scripts/import-convert-assets.sh).
In the rec or prod server, in the folder `scripts`, there is the following script, named [`import-convert-assets.sh`](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client/-/blob/dev/scripts/import-convert-assets.sh).
To import assets for the ecogesture images, run it
......
......@@ -3,13 +3,14 @@
This section will allow you to launch a proper local environment for Ecolyo-Agent
## Local usage
### Initialisation of the project
Clone the projects using thefollowing commands
```sh
git clone https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client
git clone https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server
```
### Installation of the project
......@@ -48,7 +49,7 @@ Do not use the app with the port 3000, you won't be able to login.
#### Backend and Database
In order to get Backend documentation, please refer directly to the [backend readme](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server/-/blob/dev/README.md)
In order to get Backend documentation, please refer directly to the [backend readme](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server/-/blob/dev/README.md)
#### Nginx
......@@ -84,13 +85,13 @@ In order to test the app on alpha you can do the following steps:
- Build locally your docker image for the client and/or the server
```sh
docker build . -t registry.forge.grandlyon.com/web-et-numerique/llle_project/backoffice-<server/client>:your-tag
docker build . -t registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-<server/client>:your-tag
```
- Push the image
```sh
docker push registry.forge.grandlyon.com/web-et-numerique/llle_project/backoffice-<server/client>:your-tag
docker push registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-<server/client>:your-tag
```
- Connect to alpha in ssh, go to ecolyo-agent > docker-compose.yml and change the image tag for client and/or server
......@@ -104,13 +105,13 @@ docker-compose up -d
- If you have access denied issue, try to docker login
```sh
docker login registry.forge.grandlyon.com/web-et-numerique/llle_project/
docker login registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/
```
- If you want to update alpha using the same image tag with edited image, just pull manually your new image and rebuild the concerned image
```sh
docker pull registry.forge.grandlyon.com/web-et-numerique/llle_project/backoffice-<server/client>:your-tag
docker pull registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-<server/client>:your-tag
docker-compose up -d
```
......
......@@ -9,6 +9,6 @@ This project is split between a backend and frontend; each project has its own r
## ![gitlab](../../img/gitlab-logo.svg) Repositories
[Ecolyo-Agent backend gitlab repository](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server)
[Ecolyo-Agent backend gitlab repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server)
[Ecolyo-Agent front-end gitlab repository](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client)
[Ecolyo-Agent front-end gitlab repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client)
......@@ -7,7 +7,7 @@ This section will allow you to launch a proper local environment of the Ecolyo a
Clone the project repository using the following command
```sh
git clone https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo.git
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo.git
```
## Installation of the project
......
......@@ -7,15 +7,15 @@ Ecolyo is a multi-fluid application solution towards users of the grand lyon met
This is a [Cozy](https://docs.cozy.io/en/) application that allows users to connect their energy accounts such as **EGL**, **ENEDIS** and **GRDF**, using cozy [konnectors](https://docs.cozy.io/en/cozy-stack/konnectors/).
!!! danger "Reminder"
If you're a new developer tasked to work on this project, please get acquainted with the team [processes](https://forge.grandlyon.com/web-et-numerique/wiki_web_num) and read the advised [dev environment](https://forge.grandlyon.com/web-et-numerique/wiki_web_num) documentation and the self-data [prerequisites](../index.md#installing-prerequisites).
If you're a new developer tasked to work on this project, please get acquainted with the team [processes](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) and read the advised [dev environment](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) documentation and the self-data [prerequisites](../index.md#installing-prerequisites).
## ![gitlab](../img/gitlab-logo.svg) Repositories
- [Ecolyo](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo)
- [Ecolyo.com](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo_landing_page)
- [Ecolyo](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo)
- [Ecolyo.com](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo_landing_page)
- Ecolyo Agent
- [Ecolyo-agent server](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server)
- [Ecolyo-agent client](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client)
- [Ecolyo-agent server](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server)
- [Ecolyo-agent client](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client)
## Konnectors
......
......@@ -60,10 +60,10 @@ remote_assets:
cd docker
```
- build the docker image and tag it to [ecolyo / Container Registry / cozy-env](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/container_registry):
- build the docker image and tag it to [ecolyo / Container Registry / cozy-env](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/container_registry):
```sh
docker build . -t registry.forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/cozy-env
docker build . -t registry.forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/cozy-env
```
- Then add the following command to winstack script in the package.json:
......
......@@ -14,7 +14,7 @@ Here is an example of service declaration in the ecolyo manifest:
![Manifest.webapp](/img/services/monthly-service.png)
File location is determined after the build, see [here](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo/-/tree/build/services/monthlyReport).
File location is determined after the build, see [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/-/tree/build/services/monthlyReport).
!!! note "Cron"
See the cron definition at [cozy-stack](https://docs.cozy.io/en/cozy-stack/jobs/#cron-syntax).
......
......@@ -10,7 +10,7 @@ In order to work with a self-data environment, there are a couple of prerequisit
### Grandlyon resources
Don't forget to take a look at our wiki describing general development guidelines [wiki](https://forge.grandlyon.com/web-et-numerique/wiki_web_num). It covers all the processes and guidelines towards developers.
Don't forget to take a look at our wiki describing general development guidelines [wiki](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num). It covers all the processes and guidelines towards developers.
### Cozy resources
......@@ -23,7 +23,7 @@ Link | Details
### Clone the project
To install and run the documentation on your laptop, follow the steps in the [README](https://forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc). Then:
To install and run the documentation on your laptop, follow the steps in the [README](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc). Then:
- Create a branch for your change
- Add documentation pages to `docs`, and supporting assets to `img`.
......
# EGL Konnector
[EGL repository](https://forge.grandlyon.com/web-et-numerique/llle_project/egl-konnector).
[EGL repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector).
This konnector fetches consumption measures from EGL API.
The EGL API allows us to get a user's consumption data gathered by it's connected water meter "Téléo".
......
......@@ -4,7 +4,7 @@
This section of documentation is not relevant anymore, enedis data connect has been replaced with enedis sge
This konnector fetches consumption measures from Enedis API. This is an Oauth Konnector, meaning the authentication performed to access all data is made following an Oauth2 protocol.
You can clone the project [here](https://forge.grandlyon.com/web-et-numerique/llle_project/enedis-konnector).
You can clone the project [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-konnector).
You should also check Cozy's official documentations for konnectors :
[https://docs.cozy.io/en/tutorials/konnector/getting-started/](https://docs.cozy.io/en/tutorials/konnector/getting-started/)
......
# Grdf Adict Konnector
This konnector fetches consumption measures from Grdf Adict API. This is an Oauth Konnector, meaning the authentication performed to access all data is made following an Oauth2 protocol.
You can clone the project [here](https://forge.grandlyon.com/web-et-numerique/llle_project/grdf-adict-konnector).
You can clone the project [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-adict-konnector).
You should also check Cozy's official documentations for konnectors :
[https://docs.cozy.io/en/tutorials/konnector/getting-started/](https://docs.cozy.io/en/tutorials/konnector/getting-started/)
......@@ -70,7 +70,7 @@ Build the konnector with `yarn build`.
### Install on production
Type `yarn deploy` to build on a dedicated branch.
Build branch is stored as a docker image in a registry : [Container Registry](https://forge.grandlyon.com/web-et-numerique/llle_project/grdf-adict-konnector/container_registry).
Build branch is stored as a docker image in a registry : [Container Registry](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-adict-konnector/container_registry).
### Konnector Methods
......
......@@ -17,7 +17,7 @@ Some variation have to be considered :
## ![gitlab](../img/gitlab-logo.svg) Repositories
- [enedis dataconnect (deprecated)](https://forge.grandlyon.com/web-et-numerique/llle_project/enedis-konnector)
- [enedis sge](https://forge.grandlyon.com/web-et-numerique/llle_project/enedis-sge-konnector)
- [grdf](https://forge.grandlyon.com/web-et-numerique/llle_project/grdf-konnector)
- [egl](https://forge.grandlyon.com/web-et-numerique/llle_project/egl-konnector)
- [enedis dataconnect (deprecated)](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-konnector)
- [enedis sge](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector)
- [grdf](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector)
- [egl](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector)