diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | ecs.adoc | 84 | ||||
| -rw-r--r-- | ecsa.adoc | 1 | ||||
| -rw-r--r-- | overview.adoc | 41 |
4 files changed, 67 insertions, 61 deletions
@@ -4,6 +4,6 @@ ### Build You need [asccidoctor](https://asciidoctor.org) to be installed. Then just do - asciidoctor --doctype book -a webfonts! -a hyperdoc -o ecsa.html ecsa.adoc + asciidoctor --doctype book -a webfonts! -a hyperdoc -r asciidoctor-diagram -o ecsa.html ecsa.adoc Now open the newly created `ecsa.html` file in your browser. @@ -101,11 +101,12 @@ Membership IDs (mid) These are unique ids in the scope of an ECS. They establish a relationship between a participant and a community: +[ditaa,target=membership,format=svg,scale=1.2] .... - +--------------+ 1 N +-------------+ N 1 +-------------+ - | participants +------------+ memberships +------------+ communities | - | (pid) | | (mid) | | (cid) | - +--------------+ +-------------+ +-------------+ ++--------------+ 1 N +-------------+ N 1 +-------------+ +| participants +------------+ memberships +------------+ communities | +| (pid) | | (mid) | | (cid) | ++--------------+ +-------------+ +-------------+ .... [NOTE] @@ -206,21 +207,22 @@ ECS: .Message flow through ECS application. [[fig_ecs_message_flow]] +[ditaa,target=messageflow,format=svg,scale=1.2] ---- - +-----------+ . - | ECS | /_\ - | (RAILS) | | - +-----------+ | - |Rack Module| | - | (optional)| | - +-----------+ | Message - | Webserver | | Flow - | (Proxy) | | - +-----------+ | - | | - +-----------+ | - |Participant| | - +-----------+ ++-----------+ +| ECS | ^ +| (RAILS) | | ++-----------+ | +|Rack Module| | +| (optional)| | ++-----------+ | Message +| Webserver | | Flow +| (Proxy) | | ++-----------+ | + | | ++-----------+ | +|Participant| | ++-----------+ ---- Currently supported authentication methods: @@ -347,7 +349,7 @@ Following a sample representation in JSON: "community": { "name": "Hochschulkooperation", "description": "Community zur Unterstützung hochschulübergreifender Zusammenarbeit", - "cid": 1 + "cid": 1 }, "participants": [ { @@ -752,25 +754,26 @@ Cluster building ^^^^^^^^^^^^^^^^ First lets show the topology of a clustered ECS network: +[ditaa,target=cluster,format=svg,scale=1.2] ---- - +---------+ +---------+ +---------+ - | Partic. | | Partic. | | Partic. | - | A | | B | | C | - +----+----+ +----+----+ +----+----+ - | | | - | | | - +----+------------+------------+----+ - | ECS | - +-----------------+-----------------+ - | - | - +-----------------+-----------------+ - | virtueller Participant (Cluster) | - +--------+--------+--------+--------+ - | Cluster| Cluster| Cluster| Cluster| - | Partic.| Partic.| Partic.| Partic.| - | 1 | 2 | 3 | n | - +--------+--------+--------+--------+ ++-------------+ +------------+ +-----------+ +| Participant | |Participant | |Participant| +| A | | B | | C | ++------+------+ +-----+------+ +-----+-----+ + | | | + | | | ++------+--------------+--------------+-----+ +| ECS | ++---------------------+--------------------+ + | + | ++---------------------+--------------------+ +| virtueller Participant D (Cluster) | ++----------+---------+---------+-----------+ +| Cluster | Cluster | Cluster | Cluster | +| Partic. | Partic. | Partic. | Partic. | +| 1 | 2 | 3 | n | ++----------+---------+---------+-----------+ ---- @@ -821,10 +824,11 @@ filesystem: You're able to create as many filters you want. They will be all queued/concatenated in lexical order: +[ditaa,target=filter,format=svg,scale=1.2] ---- - unfiltered +-------+ +-------+ +-------+ filtered - ---------->| 1-fil |-->| 2-fil |...| n-fil |---------> - message +-------+ +-------+ +-------+ message +unfiltered +----------+ +----------+ +----------+ filtered +---------->| Filter 1 |-->| Filter 2 | ... | Filter n |---------> +message +----------+ +----------+ +----------+ message ---- If a filter was created and copied into the appropriate filesystem path, it @@ -4,6 +4,7 @@ ECSA -- Elearning Community Service Architecture :toclevels: 3 :icons: :numbered: +:imagesdir: images :ietf_json_schema_lnk: http://tools.ietf.org/html/draft-zyp-json-schema-03 :ietf_json_schema_txt: \http://tools.ietf.org/html/draft-zyp-json-schema-03 :json_schema_home_lnk: http://json-schema.org diff --git a/overview.adoc b/overview.adoc index 146f652..fda53ea 100644 --- a/overview.adoc +++ b/overview.adoc @@ -11,27 +11,28 @@ MOM. //ifdef::hyperdoc[image::diagrams/ecsa_overview.svg[ECSA network]] //ifndef::hyperdoc[] +[ditaa,target=ecsa_overview,format=svg,scale=1.2] .... - ........... ........... - . +-----+ . . +-----+ . - . |LMS1 +------------+ +--------------+ LMS2| . - . +-----+ . | | . +-----+ . - . . | | . . - . comm. . | | . . - . A . | | . . - . . +-+-+-+ .+-------+. - . +-----+ . https | | .|HIS/LSF|. - . |LMS4 +----------+ ECS +-----------+ Proxy |. - . +-----+ . | | .+-------+. - ........... +-+-+-+ . comm. . - | | . C . - | | . . - ................................................. - . +-----+ | | . +-----+ . . - . |LMS3 +------------+ +--------------+ LMSn| . . - . +-----+ . +-----+ . . - . community B ........... . - ................................................. ++----=----+ +---------+ +| +-----+ | | +-----+ | +| |LMS1 +------------+ +--------------+ LMS2| | +| +-----+ | | | | +-----+ | +: | | | | | +| comm. A : | | : | +| | | | | | +| | +-+-+-+ |+-------+| +| +-----+ | https | | ||HIS/LSF|| +| |LMS4 +----------+ ECS +-----------+ Proxy || +| +-----+ | | | |+-------+| ++---------+ +-+-+-+ | | + | | : comm. C : + | | | | ++--------------------|-|------=-----+-----=---+-+ +| +-----+ | | | +-----+ | | +| |LMS3 +------------+ +--------------+ LMSn| | | +: +-----+ | +-----+ | : +| community B +----=----+ | ++----------------------------=------------------+ .... //endif::hyperdoc[] |