#50 Add a sequence diagram

This diagram shows the sequencial interaction of the main components
for a scan.

Note: Full arrows are syncronous calls. Half arrows areasynchronou
      calls. This is theeasier notation from UML 1.x.

The file is edited with PlatnUML: https://plantuml.com/

The rendered image is also commited so one does not need to install
UMLet first to view it.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

docs/uml/_copyright.ipuml

@@ -0,0 +1 @@
+right footer **©** 2020 iteratec GmbH

docs/uml/_iteratecTheme.ipuml

@@ -0,0 +1,86 @@
+' http://plantuml.com/skinparam
+' https://plantuml-documentation.readthedocs.io/en/latest/formatting/all-skin-params.html
+
+!define hellblau #cde6f5
+!define mittelblau #91c3e6
+!define tuerkisblau #008cd2
+!define kobaltblau #001eff
+!define lavendel #e6bedc
+!define iteragenta #bd218e
+!define dunkelpurpur #731964
+!define gelbbraun #ebd7be
+!define sand #e1c39b
+
+skinparam backgroundColor white
+
+skinparam default {
+    ArrowColor black
+    BackgroundColor white
+    FontColor black
+    FontName SansSerif
+    FontSize 10
+    Shadowing false
+}
+
+skinparam activity {
+    BorderColor dunkelpurpur
+    StartColor kobaltblau
+    EndColor iteragenta
+    BarColor lavendel
+}
+
+skinparam usecase {
+    ActorBackgroundColor lavendel
+    ActorBorderColor iteragenta
+    BorderColor dunkelpurpur
+}
+
+skinparam class {
+    BackgroundColor hellblau
+    BorderColor tuerkisblau
+}
+
+skinparam package {
+    BackgroundColor white
+    BorderColor dunkelpurpur
+}
+
+skinparam stereotype {
+    CBackgroundColor mittelblau
+    ABackgroundColor lavendel
+    IBackgroundColor gelbbraun
+    EBackgroundColor lightgray
+}
+
+skinparam component {
+    BackgroundColor lavendel
+    BorderColor iteragenta
+    InterfaceBackgroundColor mittelblau
+    InterfaceBorderColor tuerkisblau
+    Style uml2
+}
+
+skinparam note {
+    BackgroundColor gelbbraun
+    BorderColor sand
+}
+
+skinparam state {
+    BackgroundColor lavendel
+    BorderColor dunkelpurpur
+    StartColor kobaltblau
+    EndColor iteragenta
+}
+
+skinparam sequence {
+    ActorBackgroundColor lavendel
+    ActorBorderColor dunkelpurpur
+    GroupBackgroundColor hellblau
+    LifeLineBackgroundColor lavendel
+    LifeLineBorderColor dunkelpurpur
+    ParticipantBackgroundColor hellblau
+    ParticipantBorderColor mittelblau
+}
+
+skinparam CollectionsBackgroundColor hellblau
+skinparam CollectionsBorderColor mittelblau

docs/uml/sequence_overview.png

@@ -0,0 +1,64 @@
+@startuml sequence_overview
+!include _iteratecTheme.ipuml
+!include _copyright.ipuml
+
+skinparam shadowing false
+skinparam componentStyle uml2
+
+actor kubectl
+
+box "secureCodeBox"
+  participant Operator
+  participant Scanner <<Container>>
+  participant Lurcher <<Sidecar>>
+  participant Minio
+  participant Parser
+  collections ReadOnlyHooks
+  collections ReadAndWriteHooks
+end box
+
+participant Target
+
+activate Target
+activate Minio
+
+kubectl -\ Operator : start scan
+activate Operator
+Operator -> Scanner : run job
+activate Scanner
+activate Lurcher
+Scanner -> Target : scan
+Lurcher -\ Scanner : read data
+Lurcher -\ Minio : store raw results
+Scanner <-- Target
+Operator <-- Scanner
+deactivate Scanner
+deactivate Lurcher
+
+Operator -> Parser : run job
+activate Parser
+Parser -> Minio : read raw results
+Parser <-- Minio
+Parser -> Minio : store JSON findings
+Parser <-- Minio
+Operator <-- Parser
+deactivate Parser
+
+Operator -> ReadAndWriteHooks
+activate ReadAndWriteHooks
+ReadAndWriteHooks -> Minio : read issues
+ReadAndWriteHooks <-- Minio
+Operator <-- ReadAndWriteHooks
+deactivate ReadAndWriteHooks
+
+Operator -> ReadOnlyHooks
+activate ReadOnlyHooks
+ReadOnlyHooks -> Minio : read issues
+ReadOnlyHooks <-- Minio
+ReadOnlyHooks -> Minio : write issues
+ReadOnlyHooks <-- Minio
+Operator <-- ReadOnlyHooks
+deactivate ReadOnlyHooks
+
+deactivate Operator
+@enduml