Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-11-22 14:33:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

update metadata storage + scanner docs

Browse Source
This commit is contained in:
Arlan Lloyd 2025-11-18 16:04:18 +00:00
parent efec489c96
commit 8aaf786400
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DIAGRAMS.md
View File

@ -85,7 +85,6 @@ C4Context
``` ```
## Container ## Container
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")
@ -121,7 +120,7 @@ C4Container
#### Auth #### Auth
Kyoo leverages the [API Gateway](https://learn.microsoft.com/en-us/azure/architecture/microservices/design/gateway) approach to microservices and [offloads](https://learn.microsoft.com/en-us/azure/architecture/patterns/gateway-offloading) authentication at the gateway. Auth microservice is implicitly used by each other microservice for both end user authentication and microservice to microservice communications. Kyoo leverages the [API Gateway](https://learn.microsoft.com/en-us/azure/architecture/microservices/design/gateway) approach to microservices and [offloads](https://learn.microsoft.com/en-us/azure/architecture/patterns/gateway-offloading) authentication at the gateway. Auth microservice is implicitly used by each other microservice for both end user authentication and microservice to microservice communications.
*Auth microservice will not be directly represented in the other component diagrams. Instead in their relationsihp, they will specify "auth via middleware". *Auth microservice will not be directly represented in the other component diagrams. Instead in their relationsihp will specify "auth via middleware".
```mermaid ```mermaid
C4Component C4Component
@ -147,7 +146,7 @@ C4Component
Container_Boundary(api, "api") { Container_Boundary(api, "api") {
ComponentDb(api_db1, "kyoo", "Postgres", "") ComponentDb(api_db1, "kyoo", "Postgres", "")
Component(api_c1, "kyoo_api", "TypeScript", "") Component(api_c1, "kyoo_api", "TypeScript", "")
Component(api_c2, "ApiMetadata", "Volume", "Persistent. Distributed Metadata") Component(api_c2, "ApiMetadata", "S3/Volume", "Persistent. Distributed Metadata")
} }
Container_Boundary(scanner, "scanner") { Container_Boundary(scanner, "scanner") {
Component(scanner_c1, "kyoo_scanner", "Python", "") Component(scanner_c1, "kyoo_scanner", "Python", "")
@ -200,7 +199,7 @@ C4Component
Container_Boundary(transcoder, "transcoder") { Container_Boundary(transcoder, "transcoder") {
ComponentDb(transcoder_db1, "gocoder", "Postgres", "") ComponentDb(transcoder_db1, "gocoder", "Postgres", "")
Component(transcoder_c1, "kyoo_transcoder", "Go", "") Component(transcoder_c1, "kyoo_transcoder", "Go", "")
Component(transcoder_c2, "TranscodeMetadata", "Volume", "Persistent. Distributed Metadata") Component(transcoder_c2, "TranscodeMetadata", "S3/Volume", "Persistent. Distributed Metadata")
Component(transcoder_c3, "TranscodeCache", "Volume", "Volatile. Local cache") Component(transcoder_c3, "TranscodeCache", "Volume", "Volatile. Local cache")
} }
@ -223,6 +222,8 @@ C4Component
title Scanner Component Diagram title Scanner Component Diagram
Person(user, "User")
Container_Boundary(api, "api") { Container_Boundary(api, "api") {
Component(api_c1, "kyoo_api", "TypeScript", "") Component(api_c1, "kyoo_api", "TypeScript", "")
} }
@ -236,6 +237,7 @@ C4Component
System_Ext(media, "MediaLibrary", "") System_Ext(media, "MediaLibrary", "")
} }
Rel(user, scanner_c1, "http(s) <br/> auth via middleware")
Rel(scanner_c1, api_c1, "http(s) <br/> auth via middleware") Rel(scanner_c1, api_c1, "http(s) <br/> auth via middleware")
Rel(scanner_c1, scanner_db1, "") Rel(scanner_c1, scanner_db1, "")
Rel(scanner_c1, content, "http(s) <br/> gathers media info & images") Rel(scanner_c1, content, "http(s) <br/> gathers media info & images")