Skip to content

Commit 3ff003f

Browse files
committed
feat: initial PlantUML diagrams checkin
1 parent 15ef4a3 commit 3ff003f

File tree

5 files changed

+149
-0
lines changed

5 files changed

+149
-0
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.project
2+
no-commit/*
3+
*.TIF

docs/components.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Architecture
2+
3+
```puml
4+
@startuml
5+
!include <kubernetes/k8s-sprites-unlabeled-25pct>
6+
7+
component "Collector" as publisher
8+
9+
database "Redis" as redis
10+
11+
publisher -r-> redis : Add new entries
12+
13+
artifact "Event Source" as es
14+
component "Event Source\nController" as esc
15+
control "Event Source\nDeployment" as esd
16+
17+
esc -u-> es : Watch
18+
esc -d-> esd : Create
19+
esd -l-> redis : Listen
20+
21+
artifact "Sensor" as sensor
22+
component "Sensor\nController" as sensorc
23+
control "Sensor\nDeployment" as sensord
24+
component "<$node>\nWorkflow" as container
25+
26+
sensorc -u-> sensor : Watch
27+
sensorc -d-> sensord : Create
28+
sensord -r-> container : Trigger
29+
30+
queue "Event Bus" as evbus
31+
32+
esd -d-> evbus : Write\nEvents
33+
evbus -u-> sensord : Read\nEvents
34+
35+
@enduml
36+
```

docs/sequence.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Sequence Diagrams
2+
3+
## Deployment
4+
5+
```puml
6+
@startuml
7+
!include <kubernetes/k8s-sprites-unlabeled-25pct>
8+
9+
autonumber "<b>[00]"
10+
11+
participant "Event Source" as es
12+
participant "Event Source\nController" as esc
13+
control "Event Source\nDeployment" as esd
14+
15+
participant "Sensor" as sensor
16+
participant "Sensor\nController" as sensorc
17+
control "Sensor\nDeployment" as sensord
18+
19+
activate es
20+
activate esc
21+
activate sensor
22+
activate sensorc
23+
24+
par actions occur asynchronously
25+
esc -> es : Watch
26+
esc -> esd ++ : Create
27+
else
28+
sensorc -> sensor : Watch
29+
sensorc -> sensord ++ : Create
30+
end
31+
32+
deactivate es
33+
deactivate esc
34+
deactivate esd
35+
deactivate sensor
36+
deactivate sensorc
37+
deactivate sensord
38+
39+
@enduml
40+
```
41+
42+
## Ingestion
43+
44+
45+
```puml
46+
@startuml
47+
!include <kubernetes/k8s-sprites-unlabeled-25pct>
48+
49+
autonumber "<b>[00]"
50+
51+
control "Event Source\nDeployment" as esd
52+
control "Sensor\nDeployment" as sensord
53+
54+
participant "Collector" as publisher
55+
database "Redis" as redis
56+
queue "Event Bus" as evbus
57+
participant "<$node>\nWorkflow" as container
58+
59+
activate esd
60+
activate sensord
61+
62+
activate publisher
63+
activate redis
64+
activate evbus
65+
66+
par actions occur asynchronously
67+
publisher -> redis : Add new entries
68+
else
69+
esd ->o redis : Listen
70+
esd -> evbus : Write Events
71+
else
72+
sensord ->o evbus : Read Events
73+
sensord -> container ++ : Trigger
74+
container -> container : Compute
75+
container --> sensord : Return exit code
76+
destroy container
77+
end
78+
79+
deactivate esd
80+
deactivate sensord
81+
deactivate publisher
82+
deactivate redis
83+
deactivate evbus
84+
85+
@enduml
86+
```

docs/topics.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Topics
2+
3+
```puml
4+
@startuml
5+
6+
class "acme-sentinel2-stream-source" as StreamSource
7+
8+
struct "acme-sentinel2-stream-source-collected" as StreamSourceCollected {
9+
+href: URI
10+
+producer: String
11+
+subject: URI
12+
}
13+
14+
class "water-bodies-detection-trigger" as WaterBodiesDetectionTrigger
15+
16+
StreamSource -d-> StreamSourceCollected : Write Event
17+
WaterBodiesDetectionTrigger -u-> StreamSourceCollected : Read Event
18+
19+
@enduml
20+
```

mkdocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ extra_javascript:
5555

5656
nav:
5757
- Introduction: 'index.md'
58+
- Architecture:
59+
- Components: 'components.md'
60+
- Seuquence Diagrams: 'sequence.md'
61+
- Topics: 'topics.md'
5862

5963

6064
copyright: <a href="https://img.shields.io/badge/License-CC_BY--SA_4.0-lightgrey.svg">License CC BY-SA 4.0</a>, by <a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons</a>

0 commit comments

Comments
 (0)