README: Add diagrams
This commit is contained in:
parent
08002751bf
commit
51e3bfde90
14
README.md
14
README.md
@ -34,6 +34,10 @@ micro-services :
|
|||||||
- `repochecker` is a side project to check offline for synchronization
|
- `repochecker` is a side project to check offline for synchronization
|
||||||
issues.
|
issues.
|
||||||
|
|
||||||
|
Here is how thoses services speak to each others:
|
||||||
|
|
||||||
|
![Overview of the micro-services](doc/micro-services.png)
|
||||||
|
|
||||||
In the production setup, each micro-service runs in a dedicated
|
In the production setup, each micro-service runs in a dedicated
|
||||||
container, isolated from each other. Moreover, two physical machines
|
container, isolated from each other. Moreover, two physical machines
|
||||||
should be used:
|
should be used:
|
||||||
@ -47,6 +51,10 @@ should be used:
|
|||||||
requests from `phobos` filesystem and pushing to it newly generated
|
requests from `phobos` filesystem and pushing to it newly generated
|
||||||
static files.
|
static files.
|
||||||
|
|
||||||
|
Concretely, the L2 looks like this:
|
||||||
|
|
||||||
|
![Layer 2 connections](doc/l2.png)
|
||||||
|
|
||||||
So, the general filesystem is organized this way:
|
So, the general filesystem is organized this way:
|
||||||
|
|
||||||
- `DASHBOARD` contains files structuring the content of the dashboard
|
- `DASHBOARD` contains files structuring the content of the dashboard
|
||||||
@ -80,6 +88,10 @@ So, the general filesystem is organized this way:
|
|||||||
resolve the association regarding `TEAMS` directory. There is also a
|
resolve the association regarding `TEAMS` directory. There is also a
|
||||||
special directory to handle team registration.
|
special directory to handle team registration.
|
||||||
|
|
||||||
|
Here is a diagram showing how each micro-service uses directories it has access to (blue for read access, red for write access):
|
||||||
|
|
||||||
|
![Usage of directories by each micro-service](doc/directories.png)
|
||||||
|
|
||||||
Local developer setup
|
Local developer setup
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
@ -120,7 +132,7 @@ If your are trying to use the folder available with the Owncloud service, make t
|
|||||||
|
|
||||||
Running this project requires a web server (configuration is given for nginx),
|
Running this project requires a web server (configuration is given for nginx),
|
||||||
a database (currently supporting only MySQL/MariaDB), a Go compiler for the
|
a database (currently supporting only MySQL/MariaDB), a Go compiler for the
|
||||||
revision 1.16 at least and a `inotify`-aware system. You'll also need NodeJS to
|
revision 1.18 at least and a `inotify`-aware system. You'll also need NodeJS to
|
||||||
compile some user interfaces.
|
compile some user interfaces.
|
||||||
|
|
||||||
1. Above all, you need to build Node projects:
|
1. Above all, you need to build Node projects:
|
||||||
|
BIN
doc/directories.png
Normal file
BIN
doc/directories.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 544 KiB |
BIN
doc/l2.png
Normal file
BIN
doc/l2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 166 KiB |
BIN
doc/micro-services.png
Normal file
BIN
doc/micro-services.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 160 KiB |
Loading…
Reference in New Issue
Block a user