From 3a1cfcaea3396c5dff92d88ca682d51157c73316 Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Thu, 11 Jul 2024 20:20:37 +0000 Subject: [PATCH 1/6] update diagrams based upon helm updates --- DIAGRAMS.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/DIAGRAMS.md b/DIAGRAMS.md index 40f93ec6..c80d718f 100644 --- a/DIAGRAMS.md +++ b/DIAGRAMS.md @@ -99,9 +99,9 @@ C4Container System_Boundary(internal, "Kyoo") { Container(frontend, "front/") Container(backend, "back/") + ContainerQueue(emb, "emb", "", "EnterpriseMessageBus") Container(transcoder, "transcoder/") Container(scanner, "scanner/") - ContainerQueue(emb, "emb", "", "EnterpriseMessageBus") Container(autosync, "autosync/") } System_Boundary(external, "") { @@ -118,7 +118,6 @@ C4Container Rel(user, backend, "") Rel(frontend, backend, "") Rel(backend, emb, "") - Rel(backend, media, "") Rel(backend, transcoder, "") Rel_Back(autosync, emb, "") Rel(autosync, tracker, "") @@ -162,7 +161,7 @@ C4Component ### Back ```mermaid C4Component - UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="3") + UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="3") title Component Diagram for Back @@ -179,22 +178,21 @@ C4Component Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") } - Container_Boundary(media, "MediaLibrary") { - Component_Ext(media_c1, "MediaShare", "Volume", "Read Only") + Container_Boundary(emb, "emb") { + ComponentQueue(emb_e2, "events.resource", "RabbitMQ, Exchange", "unused") + ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") + ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "") + ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "") } + Container_Boundary(transcoder, "transcoder") { Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder") } - Container_Boundary(emb, "emb") { - ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "") - ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") - ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "") - ComponentQueue(emb_e2, "events.resource", "RabbitMQ, Exchange", "unused") - } + Container_Boundary(scanner, "scanner") { - Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher") + Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") } Container_Boundary(autosync, "autosync") { @@ -206,7 +204,6 @@ C4Component Rel(backend_c1, backend_db1, "") Rel(backend_c2, backend_db1, "") Rel(backend_c2, backend_db2, "") - Rel(backend_c2, media_c1, "") Rel(backend_c2, transcoder_c1, "") Rel(backend_c2, backend_c3, "") Rel(backend_c2, emb_q2, "produces") From 923b1b92ccc3d4da59736e847c5a5c71078feb19 Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Fri, 12 Jul 2024 01:49:47 +0000 Subject: [PATCH 2/6] update layout --- DIAGRAMS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DIAGRAMS.md b/DIAGRAMS.md index c80d718f..bd390c39 100644 --- a/DIAGRAMS.md +++ b/DIAGRAMS.md @@ -161,7 +161,7 @@ C4Component ### Back ```mermaid C4Component - UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="3") + UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="3") title Component Diagram for Back From 1f7050ea6e4fec0b613ff4e001c9c6f5b5507861 Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Fri, 12 Jul 2024 01:52:01 +0000 Subject: [PATCH 3/6] change layout --- DIAGRAMS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DIAGRAMS.md b/DIAGRAMS.md index bd390c39..c80d718f 100644 --- a/DIAGRAMS.md +++ b/DIAGRAMS.md @@ -161,7 +161,7 @@ C4Component ### Back ```mermaid C4Component - UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="3") + UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="3") title Component Diagram for Back From e58b3563784cecfdd97022433506cbc8d09fbe9f Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Fri, 12 Jul 2024 01:55:24 +0000 Subject: [PATCH 4/6] update formatting --- DIAGRAMS.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/DIAGRAMS.md b/DIAGRAMS.md index c80d718f..6ee24dfb 100644 --- a/DIAGRAMS.md +++ b/DIAGRAMS.md @@ -161,7 +161,7 @@ C4Component ### Back ```mermaid C4Component - UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="3") + UpdateLayoutConfig($c4ShapeInRow="5", $c4BoundaryInRow="2") title Component Diagram for Back @@ -185,15 +185,17 @@ C4Component ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "") } + Container_Boundary(scanner, "scanner") { + Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher") + Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") + } + Container_Boundary(transcoder, "transcoder") { Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder") } - Container_Boundary(scanner, "scanner") { - Component(scanner_c2, "kyoo_scanner", "python, python3.12", "matcher") - Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") - } + Container_Boundary(autosync, "autosync") { Component(autosync_c1, "kyoo_autosync", "python, python3.12", "") From dcb2b8b2ee9e4e7857785cf25eba1a77ffb66eb7 Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Fri, 12 Jul 2024 02:00:33 +0000 Subject: [PATCH 5/6] reorganize diagram --- DIAGRAMS.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/DIAGRAMS.md b/DIAGRAMS.md index 6ee24dfb..652a5409 100644 --- a/DIAGRAMS.md +++ b/DIAGRAMS.md @@ -171,18 +171,18 @@ C4Component Component(frontend_c1, "kyoo_front", "typescript, node.js", "Static Content") } Container_Boundary(backend, "back") { - Component(backend_c1, "kyoo_migrations", "C#, .NET 8.0", "Postgres Migration") - ComponentDb(backend_db1, "backend", "Postgres", "user data and session state") - Component(backend_c3, "BackendMetadata", "Volume", "Persistent. Distributed Metadata") ComponentDb(backend_db2, "search", "Meilisearch", "search resource") + Component(backend_c3, "BackendMetadata", "Volume", "Persistent. Distributed Metadata") + ComponentDb(backend_db1, "backend", "Postgres", "user data and session state") + Component(backend_c1, "kyoo_migrations", "C#, .NET 8.0", "Postgres Migration") Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") } Container_Boundary(emb, "emb") { - ComponentQueue(emb_e2, "events.resource", "RabbitMQ, Exchange", "unused") - ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") ComponentQueue(emb_e1, "events.watched", "RabbitMQ, Exchange", "") ComponentQueue(emb_q1, "autosync", "RabbitMQ, Queue", "") + ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") + ComponentQueue(emb_e2, "events.resource", "RabbitMQ, Exchange", "unused") } Container_Boundary(scanner, "scanner") { @@ -190,17 +190,13 @@ C4Component Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") } - Container_Boundary(transcoder, "transcoder") { - Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder") - } - - - - Container_Boundary(autosync, "autosync") { Component(autosync_c1, "kyoo_autosync", "python, python3.12", "") } + Container_Boundary(transcoder, "transcoder") { + Component(transcoder_c1, "kyoo_transcoder", "go, go", "Video Transcoder") + } Rel(user, backend_c2, "") Rel(backend_c1, backend_db1, "") From bfd9c79de885114aea8c3e374ea9aa6fe2c6c847 Mon Sep 17 00:00:00 2001 From: Arlan Lloyd Date: Fri, 12 Jul 2024 02:05:50 +0000 Subject: [PATCH 6/6] adjust diagrams + add note --- DIAGRAMS.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/DIAGRAMS.md b/DIAGRAMS.md index 652a5409..8b834aa3 100644 --- a/DIAGRAMS.md +++ b/DIAGRAMS.md @@ -1,4 +1,5 @@ # Diagrams +These diagrams are created with Mermaid and rendered locally. For the best experience, please use a browser. # Project Structure Kyoo is a monorepo that consists of several projects each in their own directory. Diagram below shows an outline of kyoo, projects, and artifacts. @@ -255,14 +256,14 @@ C4Component Component(scanner_c1, "kyoo_scanner", "python, python3.12", "scanner") } - Container_Boundary(emb, "emb") { - ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") - } - Container_Boundary(backend, "back") { Component(backend_c2, "kyoo_back", "C#, .NET 8.0", "API Backend") } + Container_Boundary(emb, "emb") { + ComponentQueue(emb_q2, "scanner.rescan", "RabbitMQ, Queue", "") + } + Rel(scanner_c1, scanner_q1, "produces") Rel(scanner_c1, media_c1, "watches") Rel(scanner_c1, backend_c2, "Fetch existing scans")