Skip to content

Commit

Permalink
Add Kibble architecture diagram (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
turbaszek committed Oct 12, 2020
1 parent bceae51 commit 113819c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions 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
6 changes: 5 additions & 1 deletion docs/source/setup.rst
Expand Up @@ -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
Expand All @@ -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
**********************
Expand Down

0 comments on commit 113819c

Please sign in to comment.