Commit e3dd4b10 authored by Patrik Meijer's avatar Patrik Meijer
Browse files

Finish up the services

parent cde04172
Loading
Loading
Loading
Loading
+6 −6
Changes for README.md: 6 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -43,11 +43,11 @@ docker run --rm --name caid -p 3000:3000 -p 8888:8888 -p 5150:5150 git.isis.vand
The following services are running within the monolithic caid-tools container (see `examples/docker-compose.yml` for a more realistic deployment setup with individual containers for the different services).

- **depi-server** is the main server that tracks resources across different tools. In the monolithic Docker container, it persists the state in JSON files, which does not necessarily scale well. For non-demo purposes, the depi-server also supports [Dolt DB](https://github.com/dolthub/dolt) as a persistent layer.
- **git-monitor** TODO:
- **git-gsn-monitor** TODO:
- **webgme-server** TODO:
- **webgme-monitor** TODO:
- **gitea** TODO:
- **git-monitor** is a small python server receiving webhook events from the git repositories and reports in the changes made to any git-resources in depi.
- **git-gsn-monitor** is similar to the git-monitor but instead of simply looking at the file changes, it builds up the models in memory and compares the ASTs between versions.
- **webgme-server** is a server for the metamodeling tool [WebGME](https://webgme.org/) that supports UML-like syntax for defining DSMLs such as SysML among other modeling languages.
- **webgme-monitor** small nodejs server receiving storage events from the webgme server. Just like the git based monitors it reports in any changes made to the, in this case webgme-resources, in depi.
- **gitea** is [a free, open source, git collaboration platform](https://about.gitea.com/) that hosts the git-repositories and manages the webhooks, etc.

### Front-end/User Interface
For the user interface you can either [install vscode](https://code.visualstudio.com/download) and then install the vscode extensions below (click link) or use the `caid-front-end` docker image below that is based on [theia](https://theia-ide.org/) and already prepared with the extensions.
@@ -72,7 +72,7 @@ To install the extensions you can either [search for them from within vscode](ht

Start out by cloning all the git-repositories that are part of this example. From the terminal in the bottom of the screen invoke the `clone_repos.sh` script. 
![Clone Repositories](examples/images/01-clone-repos.png)
This system consists of a system-model, modelled in webgme (where models are stored in a mongo-database), source code used by the blocks in the system-model, a few git-repositories with either test-scripts or generated data. Finally there is an assurance model modelled in GSN Assurance that is also stored under git (in the `ansr` folder in the `gsn` repository). However from a perspective of Depi, those files are managed slightly different than regular git files where instead of being treated as regular files - the models are interpreted as Abstract Semantic Graphs.
This system consists of a system-model, modelled in webgme (where models are stored in a mongo-database), source code used by the blocks in the system-model, a few git-repositories with either test-scripts or generated data. Finally there is an assurance model modelled in GSN Assurance that is also stored under git (in the `ansr` folder in the `gsn` repository). However from a perspective of Depi, those files are managed slightly different than regular git files where instead of being treated as regular files - the resources are acutal interpreted models defined in the code.

To view the current state of the example system press `Ctrl/Cmd + Shift + P` and start typing `Depi: Blackboard` and select the command. This will prompt you for a password to log into depi - the password for the `demo`-user is `123456`.
![Blackboard Command](examples/images/depi-blackboard-cmd.png)