fixes plantuml url + adds back deployment diagram

This commit is contained in:
Gabriel Matte 2024-11-27 15:52:32 -05:00
parent 2176edf7d0
commit fa95b9003f
4 changed files with 56 additions and 26 deletions

View file

@ -9,6 +9,8 @@ jobs:
build: build:
name: Deploy docs name: Deploy docs
runs-on: ubuntu-latest runs-on: ubuntu-latest
env:
PUMLURL: "https://www.plantuml.com/plantuml/"
steps: steps:
- name: Checkout main - name: Checkout main
uses: actions/checkout@v2 uses: actions/checkout@v2

View file

@ -6,29 +6,58 @@ Nous avons choisi d'exécuter les composantes de cette application avec Docker,
Voici un diagramme de déploiement expliquant la relation des composantes et comment les images Docker sont créées et déployées dans un serveur. Voici un diagramme de déploiement expliquant la relation des composantes et comment les images Docker sont créées et déployées dans un serveur.
```plantuml ```plantuml
@startuml @startuml
[Navigateur moderne (Windows/Android)] as Navigateur skinparam style strictuml
[MongoDB] as MongoDB skinparam component {
Navigateur -> "docker-compose.yml" BackgroundColor<<Container>> LightBlue
[Docker] as Docker BackgroundColor<<Image>> lightgreen
"docker-compose.yml" -> [evaluetonSavoir-backend (Express, Javscript)] }
[evaluetonSavoir-backend (Express, Javscript)] -> API_REST node "evalsa.etsmtl.ca" {
[evaluetonSavoir-backend (Express, Javscript)] -> SOCKET_SALLE artifact "docker-compose.yml" as compose
[evaluetonSavoir-routeur (nginx)] as routeur node "Docker" as docker {
API_REST -> routeur [evaluetonsavoir-routeur\n(nginx)] <<Container>> as ROC
SOCKET_SALLE -> routeur [evaluetonsavoir-frontend\n(vite + TypeScript React)] <<Container>> as FEC
[evaluetonSavoir-frontend (Vue + TypeScript React)] as frontend component "evaluetonsavoir-backend\n(Express, Javascript)" <<Container>> as BEC {
routeur -> frontend port API_REST
[Docker hub] as DockerHub port SOCKET_SALLE
[image-evaluetonSavoir-backend] -> DockerHub }
[image-evaluetonSavoir-routeur] -> DockerHub }
[image-evaluetonSavoir-frontend] -> DockerHub database "MongoDB" as BD
[GitHub] as GitHub BD -- BEC
"backend-deploy.yml" <- GitHub
"routeur-deploy.yml" <- GitHub }
"frontend-deploy.yml" <- GitHub
Navigateur <--> evalsa.etsmtl.ca : chargée à partir des pages web node "Docker hub" {
@enduml component evaluetonsavoir-routeur <<image>> as RO {
}
component evaluetonsavoir-frontend <<image>> as FE {
}
component evaluetonsavoir-backend <<image>> as BE {
}
}
node "GitHub" {
artifact "routeur-deploy.yml" <<action>> as RO_D
artifact "backend-deploy.yml" <<action>> as BE_D
artifact "frontend-deploy.yml" <<action>> as FE_D
}
BE <-- BE_D : on commit
FE <-- FE_D
RO <-- RO_D
BEC <.. BE : "pull à 5h du matin"
FEC <.. FE
ROC <.. RO
node "Navigateur moderne\n(Windows/Android)" as browser {
[React App] as RA_NAV
}
RA_NAV <.. FEC : chargée à partir des pages web
RA_NAV ..> API_REST : API REST
RA_NAV <..> SOCKET_SALLE : WebSocket
@enduml
``` ```
## Prérequis ## Prérequis

View file

@ -30,7 +30,6 @@ Afin de faciliter le déploiement de masse :
```plantuml ```plantuml
@startuml @startuml
package Proxy{ package Proxy{
component Nginx component Nginx
} }
@ -54,6 +53,7 @@ Backend --right-> MongoDb
Backend --up-> Nginx Backend --up-> Nginx
Frontend --up-> Nginx Frontend --up-> Nginx
@enduml @enduml
``` ```

View file

@ -50,8 +50,7 @@ plugins:
- search - search
- offline - offline
- plantuml: - plantuml:
default: https://www.plantuml.com/plantuml/ # default puml_url: !ENV [PUMLURL,'http://localhost:8080'] # dev
puml_url: http://localhost:8080/plantuml # dev
puml_keyword: plantuml puml_keyword: plantuml
theme: theme:
light: material/deep-purple-light light: material/deep-purple-light