added diagrams using PlantUML
Costa Tsaousis committed
Oct 17, 2016 at 20:37 UTC
dffd3b4edb8c7de3c4b68c6c7822d92d13e50ed4
4 files changed
+109
.gitignore
+6
@@ -89,3 +89,9 @@ profile/benchmark-dictionary
89
profile/benchmark-registry
90
91
*.pyc
92
+
93
+diagrams/*.png
94
+diagrams/*.atxt
95
+diagrams/plantuml.jar
96
+
97
+netdata.cppcheck
Makefile.am
+2
@@ -39,6 +39,7 @@ SUBDIRS = \
39
$(NULL)
40
41
dist_noinst_DATA= \
42
+ diagrams/registry.puml \
43
configs.signatures \
44
Dockerfile \
45
netdata.spec \
@@ -47,6 +48,7 @@ dist_noinst_DATA= \
48
# until integrated within build
49
# should be proper init.d/openrc/systemd usable
50
dist_noinst_SCRIPTS= \
51
+ diagrams/build.sh \
52
coverity-scan.sh \
53
docker-build.sh \
54
netdata-installer.sh \
diagrams/build.sh
new
+17
@@ -0,0 +1,17 @@
1
+#!/usr/bin/env bash
2
+
3
+path=$(dirname "$0")
4
+cd "${path}" || exit 1
5
+
6
+if [ ! -f "plantuml.jar" ]
7
+then
8
+ echo >&2 "Please download 'plantuml.jar' from http://plantuml.com/ and put it the same folder with me."
9
+ exit 1
10
+fi
11
+
12
+for x in *.puml
13
+do
14
+ echo >&2 "Working on ${x}..."
15
+ java -jar plantuml.jar -tpng "${x}"
16
+ # java -jar plantuml.jar -ttxt "${x}"
17
+done
diagrams/registry.puml
new
+84
@@ -0,0 +1,84 @@
1
+@startuml
2
+
3
+skinparam handwritten true
4
+skinparam monochrome true
5
+skinparam roundcorner 15
6
+
7
+skinparam sequence {
8
+ ArrowThickness 3
9
+
10
+ DividerFontColor Black
11
+ DividerFontName Comic Sans MS
12
+ DividerFontSize 15
13
+ DividerFontStyle Italic
14
+
15
+ DelayFontColor Black
16
+ DelayFontName Comic Sans MS
17
+ DelayFontSize 15
18
+ DelayFontStyle Italic
19
+
20
+ TitleFontColor Black
21
+ TitleFontName Comic Sans MS
22
+ TitleFontStyle Italic
23
+ TitleFontSize 25
24
+
25
+ ArrowColor DeepSkyBlue
26
+ ArrowFontColor Black
27
+ ArrowFontName Comic Sans MS
28
+ ArrowFontStyle Regular
29
+ ArrowFontSize 19
30
+
31
+ ActorBorderColor DeepSkyBlue
32
+
33
+ LifeLineBorderColor blue
34
+ LifeLineBackgroundColor #A9DCDF
35
+
36
+ ParticipantBorderColor DeepSkyBlue
37
+ ParticipantBackgroundColor LightBlue
38
+ ParticipantFontName Comic Sans MS
39
+ ParticipantFontSize 20
40
+ ParticipantFontColor Black
41
+
42
+ ActorBackgroundColor aqua
43
+ ActorFontColor Black
44
+ ActorFontSize 20
45
+ ActorFontName Comic Sans MS
46
+}
47
+
48
+title netdata registry operation
49
+actor "web browser" as user
50
+participant "netdata 1" as n1
51
+participant "registry 1" as r1
52
+autonumber "<b>0."
53
+
54
+== standard dashboard communication ==
55
+
56
+user ->n1 : \
57
+ hi, give me the dashboard
58
+
59
+n1 --> user : \
60
+ welcome, here it is...
61
+
62
+... a few seconds later ...
63
+
64
+== registry related communication ==
65
+
66
+user -> n1 : \
67
+ now give me registry information
68
+
69
+n1 --> user: \
70
+ here it is, talk to <b>registry 1</b>
71
+
72
+note left of r1 #eee: \
73
+ only your web browser \n\
74
+ talks to the registry
75
+
76
+user -> r1 : \
77
+ Hey <b>registry 1</b>, \
78
+I am accessing <b>netdata 1</b>...
79
+
80
+r1 --> user : \
81
+ nice!, here are other netdata servers \
82
+you have accessed in the past
83
+
84
+@enduml