[kibble] branch master updated: Add Kibble architecture diagram (#56)

[hu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kibble.git


The following commit(s) were added to refs/heads/master by this push:
     new 113819c  Add Kibble architecture diagram (#56)
113819c is described below

commit 113819c7515989bedd7a7c92e6540ac333439023
Author: Tomek Urbaszek <tu...@gmail.com>
AuthorDate: Mon Oct 12 10:23:30 2020 +0200

    Add Kibble architecture diagram (#56)
---
 docs/source/_static/images/kibble-architecture.png | Bin 0 -> 74364 bytes
 .../source/_static/images/kibble-architecture.puml |  25 +++++++++++++++++++++
 docs/source/setup.rst                              |   6 ++++-
 3 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/docs/source/_static/images/kibble-architecture.png b/docs/source/_static/images/kibble-architecture.png
new file mode 100644
index 0000000..6fa6758
Binary files /dev/null and b/docs/source/_static/images/kibble-architecture.png differ
diff --git a/docs/source/_static/images/kibble-architecture.puml b/docs/source/_static/images/kibble-architecture.puml
new file mode 100644
index 0000000..4a924fa
--- /dev/null
+++ b/docs/source/_static/images/kibble-architecture.puml
@@ -0,0 +1,25 @@
+@startuml
+actor user
+database elasticsearch
+rectangle "Apache Kibble" {
+  file kibble.yaml
+  rectangle webserver {
+     collections "static files"
+  }
+  rectangle gunicorn {
+     rectangle API
+  }
+  rectangle API
+}
+user <-> webserver: (web app)
+webserver <--> gunicorn: (reverse proxy)
+API <-> elasticsearch
+API <~~ kibble.yaml
+
+rectangle "Apache Kibble Scanners" {
+  collections scanners
+  file config.yaml
+}
+scanners --> elasticsearch
+config.yaml ~> scanners
+@enduml
diff --git a/docs/source/setup.rst b/docs/source/setup.rst
index c4c43d7..ad82170 100644
--- a/docs/source/setup.rst
+++ b/docs/source/setup.rst
@@ -16,7 +16,7 @@ The Kibble Server (kibble)
    This is the main database and UI Server. It serves as the hub for the
    scanners to connect to, and provides the overall management of
    sources as well as the visualizations and API end points.
-   
+
 The Kibble Scanner Applications (kibble-scanners)
    This is a collection of scanning applications each designed to work
    with a specific type of resource (a git repo, a mailing list, a JIRA
@@ -25,6 +25,10 @@ The Kibble Scanner Applications (kibble-scanners)
    multiple plugins capable of dealing with specific aspects of a
    resource.
 
+The following diagram shows Kibble architecture:
+
+.. figure:: _static/images/kibble-architecture.png
+
 **********************
 Component Requirements
 **********************