summaryrefslogtreecommitdiffstats
path: root/diagrams
diff options
context:
space:
mode:
Diffstat (limited to 'diagrams')
-rwxr-xr-xdiagrams/build.sh20
-rw-r--r--diagrams/config.puml46
-rw-r--r--diagrams/registry.puml40
3 files changed, 106 insertions, 0 deletions
diff --git a/diagrams/build.sh b/diagrams/build.sh
new file mode 100755
index 000000000..53f0ea7ab
--- /dev/null
+++ b/diagrams/build.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+path=$(dirname "$0")
+cd "${path}" || exit 1
+
+if [ ! -f "plantuml.jar" ]
+then
+ echo >&2 "Please download 'plantuml.jar' from http://plantuml.com/ and put it the same folder with me."
+ exit 1
+fi
+
+for x in *.puml
+do
+ [ "${x}" = "config.puml" ] && continue
+
+ echo >&2 "Working on ${x}..."
+ java -jar plantuml.jar -tpng "${x}"
+ java -jar plantuml.jar -tsvg "${x}"
+ # java -jar plantuml.jar -ttxt "${x}"
+done
diff --git a/diagrams/config.puml b/diagrams/config.puml
new file mode 100644
index 000000000..0ce0932f5
--- /dev/null
+++ b/diagrams/config.puml
@@ -0,0 +1,46 @@
+
+skinparam handwritten true
+skinparam monochrome true
+skinparam roundcorner 15
+
+skinparam sequence {
+ ArrowThickness 3
+
+ DividerFontColor Black
+ DividerFontName Comic Sans MS
+ DividerFontSize 15
+ DividerFontStyle Italic
+
+ DelayFontColor Black
+ DelayFontName Comic Sans MS
+ DelayFontSize 15
+ DelayFontStyle Italic
+
+ TitleFontColor Black
+ TitleFontName Comic Sans MS
+ TitleFontStyle Italic
+ TitleFontSize 25
+
+ ArrowColor DeepSkyBlue
+ ArrowFontColor Black
+ ArrowFontName Comic Sans MS
+ ArrowFontStyle Regular
+ ArrowFontSize 19
+
+ ActorBorderColor DeepSkyBlue
+
+ LifeLineBorderColor blue
+ LifeLineBackgroundColor #A9DCDF
+
+ ParticipantBorderColor DeepSkyBlue
+ ParticipantBackgroundColor LightBlue
+ ParticipantFontName Comic Sans MS
+ ParticipantFontSize 20
+ ParticipantFontColor Black
+
+ ActorBackgroundColor aqua
+ ActorFontColor Black
+ ActorFontSize 20
+ ActorFontName Comic Sans MS
+}
+
diff --git a/diagrams/registry.puml b/diagrams/registry.puml
new file mode 100644
index 000000000..51a337fab
--- /dev/null
+++ b/diagrams/registry.puml
@@ -0,0 +1,40 @@
+@startuml
+!include config.puml
+
+title netdata registry operation
+actor "web browser" as user
+participant "netdata 1" as n1
+participant "registry 1" as r1
+autonumber "<b>0."
+
+== standard dashboard communication ==
+
+user ->n1 : \
+ hi, give me the dashboard
+
+n1 --> user : \
+ welcome, here it is...
+
+... a few seconds later ...
+
+== registry related communication ==
+
+user -> n1 : \
+ now give me registry information
+
+n1 --> user: \
+ here it is, talk to <b>registry 1</b>
+
+note left of r1 #eee: \
+ only your web browser \n\
+ talks to the registry
+
+user -> r1 : \
+ Hey <b>registry 1</b>, \
+I am accessing <b>netdata 1</b>...
+
+r1 --> user : \
+ nice!, here are other netdata servers \
+you have accessed in the past
+
+@enduml