Skip to content
This repository was archived by the owner on Nov 11, 2025. It is now read-only.

Commit 113819c

Browse files
authored
Add Kibble architecture diagram (#56)
1 parent bceae51 commit 113819c

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed
72.6 KB
Loading
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
@startuml
2+
actor user
3+
database elasticsearch
4+
rectangle "Apache Kibble" {
5+
file kibble.yaml
6+
rectangle webserver {
7+
collections "static files"
8+
}
9+
rectangle gunicorn {
10+
rectangle API
11+
}
12+
rectangle API
13+
}
14+
user <-> webserver: (web app)
15+
webserver <--> gunicorn: (reverse proxy)
16+
API <-> elasticsearch
17+
API <~~ kibble.yaml
18+
19+
rectangle "Apache Kibble Scanners" {
20+
collections scanners
21+
file config.yaml
22+
}
23+
scanners --> elasticsearch
24+
config.yaml ~> scanners
25+
@enduml

docs/source/setup.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Kibble Server (kibble)
1616
This is the main database and UI Server. It serves as the hub for the
1717
scanners to connect to, and provides the overall management of
1818
sources as well as the visualizations and API end points.
19-
19+
2020
The Kibble Scanner Applications (kibble-scanners)
2121
This is a collection of scanning applications each designed to work
2222
with a specific type of resource (a git repo, a mailing list, a JIRA
@@ -25,6 +25,10 @@ The Kibble Scanner Applications (kibble-scanners)
2525
multiple plugins capable of dealing with specific aspects of a
2626
resource.
2727

28+
The following diagram shows Kibble architecture:
29+
30+
.. figure:: _static/images/kibble-architecture.png
31+
2832
**********************
2933
Component Requirements
3034
**********************

0 commit comments

Comments
 (0)