Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-06-01 04:34:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

update formatting

Browse Source
This commit is contained in:
Arlan Lloyd 2024-06-21 11:22:06 +00:00 committed by Zoe Roux
parent 4b6bc0014a
commit 53321ee53c
1 changed files with 60 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
DIAGRAMS.md
View File

@ -70,85 +70,81 @@ Diagrams that focus on capturing project from a high level point of view. Contex
## Context ## Context
```mermaid ```mermaid
C4Context C4Context
UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="2")
title Context Diagram for Kyoo
Person(user, "User")
System(kyoo, "Kyoo", "")
System_Ext(media, "MediaLibrary", "")
System_Ext(content, "ContentDatabase", "")
System_Ext(tracker, "ActivityTracker", "")
title Context diagram for Kyoo System Rel(user, kyoo, "")
Person(user, "User") Rel(kyoo, content, "")
Rel(kyoo, media, "")
System(kyoo, "Kyoo", "") Rel(kyoo, tracker, "")
System_Ext(media, "MediaLibrary", "")
System_Ext(content, "ContentDatabase", "")
System_Ext(tracker, "ActivityTracker", "")
Rel(user, kyoo, "")
Rel(kyoo, content, "")
Rel(kyoo, media, "")
Rel(kyoo, tracker, "")
UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="2")
``` ```
## Container ## Container
Messaging is middleware. EnterpriseMessageBus is for any messaging handled between different projects. Messaging is middleware. EnterpriseMessageBus is for any messaging handled between different projects.
```mermaid ```mermaid
C4Container C4Container
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1") UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
title Container diagram for Kyoo System title Container diagram for Kyoo System
Person(user, "User")
System_Boundary(internal, "Kyoo") { Person(user, "User")
Container(frontend, "front/") System_Boundary(internal, "Kyoo") {
Container(backend, "back/") Container(frontend, "front/")
Container(transcoder, "transcoder/") Container(backend, "back/")
Container(transcoder, "transcoder/")
Container(autosync, "autosync/")
ContainerQueue(emb, "emb", "", "EnterpriseMessageBus")
Container(scanner, "scanner/")
}
System_Boundary(external, "External") {
System_Ext(tracker, "ActivityTracker", "")
System_Ext(media, "MediaLibrary", "")
System_Ext(content, "ContentDatabase", "")
}
Container(autosync, "autosync/") Rel(user, frontend, "")
ContainerQueue(emb, "emb", "", "EnterpriseMessageBus") Rel(user, backend, "")
Container(scanner, "scanner/") Rel(frontend, backend, "")
} Rel(backend, emb, "")
Rel(backend, media, "")
System_Boundary(external, "External") { Rel(backend, transcoder, "")
System_Ext(tracker, "ActivityTracker", "") Rel(autosync, emb, "")
System_Ext(media, "MediaLibrary", "") Rel(autosync, tracker, "")
System_Ext(content, "ContentDatabase", "") Rel(scanner, emb, "")
Rel(scanner, backend, "")
} Rel(scanner, media, "")
Rel(scanner, content, "")
Rel(user, frontend, "") Rel(transcoder, media, "")
Rel(user, backend, "")
Rel(frontend, backend, "")
Rel(backend, emb, "")
Rel(backend, media, "")
Rel(backend, transcoder, "")
Rel(autosync, emb, "")
Rel(autosync, tracker, "")
Rel(scanner, emb, "")
Rel(scanner, backend, "")
Rel(scanner, media, "")
Rel(scanner, content, "")
Rel(transcoder, media, "")
``` ```
# Component # Component
## Autosync ## Autosync
```mermaid ```mermaid
C4Component C4Component
title Component Diagram
UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="2") UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="2")
title Component Diagram for Autosync
Container_Boundary(autosync, "autosync") { Container_Boundary(autosync, "autosync") {
Component(autosync_c1, "kyoo_autosync", "python, python3.12", "") Component(autosync_c1, "kyoo_autosync", "python, python3.12", "")
} }
Container_Boundary(emb, "emb") { Container_Boundary(emb, "emb") {
ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "") ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "")
ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "") ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "")
} }
Container_Boundary(tracker, "ActivityTracker") { Container_Boundary(tracker, "ActivityTracker") {
Component_Ext(tracker_c1, "TrackerProvider", "API", "simkl") Component_Ext(tracker_c1, "TrackerProvider", "API", "simkl")
} }
Container_Boundary(backend, "back") { Container_Boundary(backend, "back") {
Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend")
} }
@ -161,78 +157,64 @@ Messaging is middleware. EnterpriseMessageBus is for any messaging handled betw
## Back ## Back
```mermaid ```mermaid
C4Component C4Component
title Component Diagram
UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="3") UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="3")
title Component Diagram for Back
Person(user, "User") Person(user, "User")
Container_Boundary(backend, "back") {
Container_Boundary(backend, "backend") {
Component(backend_c1, "kyoo_migrations", "C#, .NET 8.0", "Postgres Migration") Component(backend_c1, "kyoo_migrations", "C#, .NET 8.0", "Postgres Migration")
ComponentDb(backend_db2, "search", "Meilisearch", "search resource") ComponentDb(backend_db2, "search", "Meilisearch", "search resource")
Component(backend_c3, "BackendMetadata", "Volume", "Persistent. Distributed Metadata") Component(backend_c3, "BackendMetadata", "Volume", "Persistent. Distributed Metadata")
ComponentDb(backend_db1, "backend", "Postgres", "user data and session state") ComponentDb(backend_db1, "backend", "Postgres", "user data and session state")
Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend")
} }
Container_Boundary(media, "MediaLibrary") { Container_Boundary(media, "MediaLibrary") {
Component_Ext(media_c1, "MediaShare", "Volume", "Read Only") Component_Ext(media_c1, "MediaShare", "Volume", "Read Only")
} }
Container_Boundary(transcoder, "transcoder") { Container_Boundary(transcoder, "transcoder") {
Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder") Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder")
} }
Container_Boundary(scanner, "scanner") { Container_Boundary(scanner, "scanner") {
Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher") Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher")
} }
Container_Boundary(emb, "embessage") { Container_Boundary(emb, "embessage") {
ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "")
ComponentQueue(emb_e2, "events.resource", "RabbitMQ, Exchange", "unused") ComponentQueue(emb_e2, "events.resource", "RabbitMQ, Exchange", "unused")
ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "") ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "")
ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "") ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "")
} }
Container_Boundary(autosync, "autosync") { Container_Boundary(autosync, "autosync") {
Component(autosync_c1, "kyoo_autosync", "python, python3.12", "") Component(autosync_c1, "kyoo_autosync", "python, python3.12", "")
} }
Rel(user, backend_c2, "") Rel(user, backend_c2, "")
Rel(backend_c1, backend_db1, "") Rel(backend_c1, backend_db1, "")
Rel(backend_c2, backend_db1, "") Rel(backend_c2, backend_db1, "")
Rel(backend_c2, backend_db2, "") Rel(backend_c2, backend_db2, "")
Rel(backend_c2, media_c1, "") Rel(backend_c2, media_c1, "")
Rel(backend_c2, transcoder_c1, "") Rel(backend_c2, transcoder_c1, "")
Rel(backend_c2, backend_c3, "") Rel(backend_c2, backend_c3, "")
Rel(backend_c2, emb_q2, "produces") Rel(backend_c2, emb_q2, "produces")
Rel(backend_c2, emb_e1, "produces") Rel(backend_c2, emb_e1, "produces")
Rel(backend_c2, emb_e2, "produces") Rel(backend_c2, emb_e2, "produces")
Rel(emb_e1, emb_q1, "bound") Rel(emb_e1, emb_q1, "bound")
Rel(autosync_c1, emb_q1, "consumes") Rel(autosync_c1, emb_q1, "consumes")
Rel(scanner_c2, emb_q2, "consumes") Rel(scanner_c2, emb_q2, "consumes")
``` ```
## Front ## Front
```mermaid ```mermaid
C4Component C4Component
title Component Diagram
UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="2") UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="2")
Person(user, "User") title Component Diagram for Front
Container_Boundary(frontend, "frontend") { Person(user, "User")
Container_Boundary(frontend, "front") {
Component(frontend_c1, "kyoo_front", "typescript, node.js", "Static Content") Component(frontend_c1, "kyoo_front", "typescript, node.js", "Static Content")
} }
Container_Boundary(backend, "back") { Container_Boundary(backend, "back") {
Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend")
} }
@ -243,24 +225,22 @@ Messaging is middleware. EnterpriseMessageBus is for any messaging handled betw
## Scanner ## Scanner
```mermaid ```mermaid
C4Component C4Component
title Component Diagram
UpdateLayoutConfig($c4ShapeInRow="1", $c4BoundaryInRow="3") UpdateLayoutConfig($c4ShapeInRow="1", $c4BoundaryInRow="3")
title Component Diagram for Scanner
Container_Boundary(media, "MediaLibrary") { Container_Boundary(media, "MediaLibrary") {
Component_Ext(media_c1, "MediaShare", "Volume", "Read Only") Component_Ext(media_c1, "MediaShare", "Volume", "Read Only")
} }
Container_Boundary(scanner, "scanner") { Container_Boundary(scanner, "scanner") {
Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner")
ComponentQueue(scanner_q1, "scanner", "RabbitMQ, Queue", "") ComponentQueue(scanner_q1, "scanner", "RabbitMQ, Queue", "")
Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher") Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher")
} }
Container_Boundary(emb, "emb") { Container_Boundary(emb, "emb") {
ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "")
} }
Container_Boundary(content, "ContentDatabase") { Container_Boundary(content, "ContentDatabase") {
Component_Ext(content_c1, "ContentProvider", "API", "tmdb or tvdb") Component_Ext(content_c1, "ContentProvider", "API", "tmdb or tvdb")
} }
@ -268,7 +248,6 @@ Messaging is middleware. EnterpriseMessageBus is for any messaging handled betw
Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend")
} }
Rel(scanner_c1, scanner_q1, "produces") Rel(scanner_c1, scanner_q1, "produces")
Rel(scanner_c1, media_c1, "watches") Rel(scanner_c1, media_c1, "watches")
Rel(scanner_c2, content_c1, "Fetch media data") Rel(scanner_c2, content_c1, "Fetch media data")
@ -280,20 +259,19 @@ Messaging is middleware. EnterpriseMessageBus is for any messaging handled betw
## Transcoder ## Transcoder
```mermaid ```mermaid
C4Component C4Component
title Component Diagram
UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="2") UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="2")
title Component Diagram for Transcoder
Container_Boundary(transcoder, "transcoder") { Container_Boundary(transcoder, "transcoder") {
Component(transcoder_c2, "TranscodeMetadata", "Volume", "Persistent. Distributed Metadata") Component(transcoder_c2, "TranscodeMetadata", "Volume", "Persistent. Distributed Metadata")
Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder") Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder")
Component(transcoder_c3, "TranscodeCache", "Volume", "Volatile. Local cache") Component(transcoder_c3, "TranscodeCache", "Volume", "Volatile. Local cache")
} }
Container_Boundary(media, "MediaLibrary") { Container_Boundary(media, "MediaLibrary") {
Component_Ext(media_c1, "MediaShare", "Volume", "Read Only") Component_Ext(media_c1, "MediaShare", "Volume", "Read Only")
} }
Container_Boundary(backend, "back") { Container_Boundary(backend, "back") {
Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend")
} }