From 900a7873bf709d2ca73cc7094c3a3184d8b2d563 Mon Sep 17 00:00:00 2001
From: Gabryel Reyes <gabryel.reyes@newtec.de>
Date: Mon, 15 Jul 2024 17:07:51 +0200
Subject: [PATCH] Added deployment diagram #8

---
 README.md               |  4 +++
 doc/uml/deployment.puml | 78 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+)
 create mode 100644 doc/uml/deployment.puml

diff --git a/README.md b/README.md
index 8029457..c57748a 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,10 @@ pyMetricCli requires an adapter file to be supplied by the user. This shall cont
 
 An example adapter can be found [here](examples/adapter/adapter.py).
 
+### Deployment
+
+![deployment](https://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/NewTec-GmbH/pyMetricCli/main/doc/uml/deployment.puml)
+
 ## Usage
 
 Show help information:
diff --git a/doc/uml/deployment.puml b/doc/uml/deployment.puml
new file mode 100644
index 0000000..30023f1
--- /dev/null
+++ b/doc/uml/deployment.puml
@@ -0,0 +1,78 @@
+@startuml DeploymentDiagram
+
+node "Apache Superset"<<virtual-machine>> as superset
+
+database "DB Server" {
+    component "Database" as supersetDb
+
+    note bottom of supersetDb
+        The database is project specific, means
+        one database per project.
+    end note
+
+    component "Database" as jiraDb
+}
+
+node "Polarion"<<virtual-machine>> as polarion
+database "SVN Repository" as svnRepo
+
+node "JIRA"<<virtual-machine>> as jira
+
+interface "REST API" as supersetRestApi
+interface "REST API" as jiraRestApi
+interface "SOAP API" as polarionSoapApi
+
+superset --- supersetRestApi
+jira --- jiraRestApi
+jira -- jiraDb
+polarion --- polarionSoapApi
+polarion -- svnRepo
+
+superset -- supersetDb
+
+node "Continuous Integration Server"<<virtual-machine>> {
+
+    package "scripts" {
+        component "pyJiraCli" as pyJiraCli
+        component "pyPolarionCli" as pyPolarionCli
+        component "pySupersetCli" as pySupersetCli
+        component "pyMetricCli" as pyMetricCli
+        component "pyMetricCli_Adapter" as adapter
+
+        pyJiraCli <.. pyMetricCli: <<uses>>
+        pyPolarionCli <.. pyMetricCli: <<uses>>
+        pySupersetCli <.. pyMetricCli: <<uses>>
+        pyMetricCli *--> adapter
+
+        note right of pyMetricCli
+            Called by CI cyclic to generate
+            metrics.
+        end note
+
+        note right of adapter
+            Is project specific.
+            Called by CI cyclic to generate
+            metrics.
+        end note
+    }
+}
+
+jiraRestApi )-- pyJiraCli: <<uses>>
+polarionSoapApi )-- pyPolarionCli: <<uses>>
+
+supersetRestApi )-- pySupersetCli: <<writes>>
+
+note top of superset
+    Report frontend for project metrics.
+end note
+
+note top of jira
+    Issue tracking system.
+end note
+
+note top of polarion
+    Requirements management.
+end note
+
+
+@enduml
\ No newline at end of file