diff --git a/docs/developer/system/architecture.png b/docs/developer/system/architecture.png deleted file mode 100644 index ae1ad2d46..000000000 Binary files a/docs/developer/system/architecture.png and /dev/null differ diff --git a/docs/developer/system/c4l1.png b/docs/developer/system/c4l1.png deleted file mode 100644 index bb981411d..000000000 Binary files a/docs/developer/system/c4l1.png and /dev/null differ diff --git a/docs/developer/system/c4l3.png b/docs/developer/system/c4l3.png deleted file mode 100644 index 13b1099cc..000000000 Binary files a/docs/developer/system/c4l3.png and /dev/null differ diff --git a/docs/developer/system/client.md b/docs/developer/system/client.md deleted file mode 100644 index f715a3b1d..000000000 --- a/docs/developer/system/client.md +++ /dev/null @@ -1,13 +0,0 @@ -# Website - -The -[Website](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/client#readme) -is how the end-users interact with the software platform. - -This is the Client side (frontend) for Digital Twin -as a Service (DTaaS) software. The software provides -a React single page web application for the Digital Twin support platform. - -## Client Architecture - -![Client architecture](package-diagram.png) \ No newline at end of file diff --git a/docs/developer/system/lib-ms.md b/docs/developer/system/lib-ms.md deleted file mode 100644 index 0ec61c343..000000000 --- a/docs/developer/system/lib-ms.md +++ /dev/null @@ -1,167 +0,0 @@ -# Library Microservice - -[The Library Microservices](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/servers/lib#readme) -fulfil the core requirements of the system. The microservices are complementary and composable. - -The service mesh enables discovery of microservices, -load balancing and authentication functionalities. -There are microservices for catering to author, store, explore, -configure, execute and scenario analysis requirements. - -## Lib-MS Architecture - -### Class Architecture - -```mermaid -classDiagram - class FilesResolver { - -filesService: IFilesService - +listDirectory(path: string): Promise - +readFile(path: string): Promise - } - - class FilesServiceFactory { - -configService: ConfigService - -gitlabFilesService: GitlabFilesService - -localFilesService: LocalFilesService - +create(): IFilesService - } - - class GitlabFilesService { - -configService: ConfigService - -parseArguments(path: string): Promise - -sendRequest(query: string): Promise - -executeQuery(path: string, getQuery: QueryFunction): Promise - +listDirectory(path: string): Promise - +readFile(path: string): Promise - } - - class LocalFilesService { - -configService: ConfigService - -getFileStats(fullPath: string, file: string): Promise - +listDirectory(path: string): Promise - +readFile(path: string): Promise - } - - class ConfigService { - +get(propertyPath: string): any - } - - class IFilesService{ - listDirectory(path: string): Promise - readFile(path: string): Promise - } - - IFilesService <|-- FilesResolver: uses - IFilesService <|.. GitlabFilesService: implements - IFilesService <|.. LocalFilesService: implements - IFilesService <|-- FilesServiceFactory: creates - ConfigService <|-- FilesServiceFactory: uses - ConfigService <|-- GitlabFilesService: uses - ConfigService <|-- LocalFilesService: uses -``` - -### Sequence Architecture - -```mermaid -sequenceDiagram - actor Client - actor Traefik - - box LightGreen Library Microservice - participant FR as FilesResolver - participant FSF as FilesServiceFactory - participant CS as ConfigService - participant IFS as IFilesService - participant LFS as LocalFilesService - participant GFS as GitlabFilesService - end - - participant FS as Local File System DB - participant GAPI as GitLab API DB - - Client ->> Traefik : HTTP request - Traefik ->> FR : GraphQL query - activate FR - - FR ->> FSF : create() - activate FSF - - FSF ->> CS : getConfiguration("MODE") - activate CS - - CS -->> FSF : return configuration value - deactivate CS - - alt MODE = Local - FSF ->> FR : return filesService (LFS) - deactivate FSF - - FR ->> IFS : listDirectory(path) or readFile(path) - activate IFS - - IFS ->> LFS : listDirectory(path) or readFile(path) - activate LFS - - LFS ->> CS : getConfiguration("LOCAL_PATH") - activate CS - - CS -->> LFS : return local path - deactivate CS - - LFS ->> FS : Access filesystem - alt Filesystem error - FS -->> LFS : Filesystem error - LFS ->> LFS : Throw new InternalServerErrorException - LFS -->> IFS : Error - else Successful file operation - FS -->> LFS : Return filesystem data - LFS ->> IFS : return Promise - end - deactivate LFS - else MODE = GitLab - FSF ->> FR : return filesService (GFS) - %%deactivate FSF - - FR ->> IFS : listDirectory(path) or readFile(path) - activate IFS - - IFS ->> GFS : listDirectory(path) or readFile(path) - activate GFS - - GFS ->> GFS : parseArguments(path) - GFS ->> GFS : executeQuery() - - GFS ->> CS : getConfiguration("GITLAB_API_URL", "GITLAB_TOKEN") - activate CS - - CS -->> GFS : return GitLab API URL and Token - deactivate CS - - GFS ->> GAPI : sendRequest() - alt GitLab API error - GAPI -->> GFS : API error - GFS ->> GFS : Throw new Error("Invalid query") - GFS -->> IFS : Error - else Successful GitLab API operation - GAPI -->> GFS : Return API response - GFS ->> IFS : return Promise - end - deactivate GFS - end - - alt Error thrown - IFS ->> FR : return Error - deactivate IFS - FR ->> Traefik : return Error - Traefik ->> Client : HTTP error response - else Successful operation - IFS ->> FR : return Promise - deactivate IFS - FR ->> Traefik : return Promise - Traefik ->> Client : HTTP response - end - - deactivate FR - -``` diff --git a/docs/developer/system/package-diagram.png b/docs/developer/system/package-diagram.png deleted file mode 100644 index bf2a0996d..000000000 Binary files a/docs/developer/system/package-diagram.png and /dev/null differ