5-spot/docs/architecture/calm/templates/mermaid/system.md.hbs at 63ee14aff3b1fb86a94e89fd00ff2f111de2c42e · finos/5-spot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# System Architecture

[![FINOS CALM](https://img.shields.io/badge/FINOS_CALM-1.37-blue?logo=finos)](https://calm.finos.org/)

!!! note "Auto-generated"

    Rendered from `docs/architecture/calm/architecture.json` by the CALM
    CLI (`calm template`). **Do not edit this file by hand** — edit the
    architecture JSON or the Handlebars template at
    `docs/architecture/calm/templates/mermaid/system.md.hbs` and regenerate
    with `make calm-diagrams`.

A single Mermaid `flowchart LR` of every node in the CALM architecture
and the connections between them. `connects` and `interacts`
relationships become arrows (the protocol, when defined, labels the
arrow); `deployed-in` / `composed-of` containers become subgraphs.

```mermaid
flowchart LR
{{#each nodes}}
{{#unless (eq node-type "ecosystem")}}
    {{unique-id}}["{{{name}}}"]
{{/unless}}
{{/each}}
{{#each relationships}}
{{#with relationship-type.deployed-in}}
    subgraph sg_{{container}} [{{kebabToTitleCase container}}]
{{#each nodes}}
        {{this}}
{{/each}}
    end
{{/with}}
{{#with relationship-type.composed-of}}
    subgraph sg_{{container}} [{{kebabToTitleCase container}}]
{{#each nodes}}
        {{this}}
{{/each}}
    end
{{/with}}
{{#with relationship-type.connects}}
{{#if ../protocol}}
    {{source.node}} -->|{{../protocol}}| {{destination.node}}
{{else}}
    {{source.node}} --> {{destination.node}}
{{/if}}
{{/with}}
{{#with relationship-type.interacts}}
{{#each nodes}}
    {{../actor}} --> {{this}}
{{/each}}
{{/with}}
{{/each}}
```

<sub>Source: nodes and relationships in `architecture.json`.</sub>