Merge pull request #4 from metno/1-make-container-diagram-show-on-github

1 make container diagram show on GitHub

Author: havardf

README.md

@@ -55,55 +55,31 @@ The application is made up of several binaries working together.
 
 ### C4 container diagram
 
-```plantuml
-@startuml
-!include  <C4/C4_Context.puml>
-!include  <C4/C4_Container.puml>
-!include <office/Users/user.puml>
-
-Person_Ext(yr, "yr.no (EKP)", "yr.no including apps and web page")
-System_Ext(pingdom, "Pingdom (EXT)", "Health checks")
-
-System_Boundary(metno, "Met") {
-  System_Ext(api_met_no, "api.met.no (EKS)")
-  System_Ext(ecflow, "ecflow ppi jobs (INT)")
-  System_Ext(grafana, "Grafana (INT)", "Team Punkt's grafana server")
-}
-
-System_Boundary(forti, "Forti") {
-  Container(fortiup, "fortiup (INT)", "Go command-line program", "Upload Forti netcdf dataset from filesystem.")
-  System_Boundary(azure, "Azure") {
-    System(azureblob, "Azure Blob Storage (SAS)")
-    System_Boundary(k8s, "Kubernetes") {
-      System(ingress, "Ingress controller (EKS)")
-      Container(healthz, "Healthz (INT)", "Go web server", "Periodically run integration tests and deliver status over REST.")
-      System(prometheus, "Prometheus (INT)", "Provides insights into performance and other statistics about each forti component. Prometheus web server is password-protected.")
-      System_Boundary(core, "Core") {
-        Container(frontends, "Frontends (INT)", "Go web servers", "Several systems. Serve point forecast timeseries over REST in geojson, xml or other formats.<br>Each instance differs in output format only.")
-        Container(correctedforecaster, "Correctedforecaster (INT)", "Go GRPC server", "Request forecast data, adjust and serve.")
-        Container(rawdataforecaster, "Rawdataforecaster (INT)", "Go GRPC server", "Serve forecast timeseries from memory cache or blob storage.")
-        Rel(frontends, correctedforecaster, "grpc req/reply (lvl 2)")
-        Rel(correctedforecaster, rawdataforecaster, "grpc req/reply (lvl 2)")
-      }
-      Rel(ingress, frontends, "http (lvl 2)")
-      Rel(ingress, healthz, "http (lvl 2)")
-      Rel(ingress, prometheus, "http (lvl 2)")
-      Rel(healthz, ingress, "rest (lvl 2)")
-      Rel(correctedforecaster, azureblob, "Download topography (lvl 2)")
-      Rel_R(prometheus, frontends, "http (lvl 2)")
-      Rel_R(prometheus, correctedforecaster, "http (lvl 2)")
-      Rel_R(prometheus, rawdataforecaster, "http (lvl 2)")
+```mermaid
+C4Container
+  title C4 Container Diagram - Forti
+
+  Person_Ext(client, "API Client", "Consumes forecast data over REST")
+  Person_Ext(dataloader, "Dataset Loader", "Loads forecast datasets into the forti object store")
+
+  Boundary(forti, "Forti") {
+    Boundary(core, "Core") {
+      Container(frontends, "Frontends", "Go", "Serve point forecast timeseries over REST")
+      Container(correctedforecaster, "Correctedforecaster", "Go GRPC", "Post-process and serve forecast data")
+      Container(rawdataforecaster, "Rawdataforecaster", "Go GRPC", "Serve forecast from cache or object store")
+    }
+    Boundary(support, "Support") {
+      System(objectstore, "Object Store", "Stores forecast datasets")
+      Container(healthz, "Healthz", "Go", "Runs integration tests and reports health")
+      System(prometheus, "Prometheus", "Collects metrics from Forti components")
     }
-    Rel_R(rawdataforecaster, azureblob, "Read forecast data (lvl 2)")
   }
-  Rel(fortiup, azureblob, "Upload forecast data(lvl 2)")
-}
-
-Rel_D(grafana, ingress, "https (lvl 0)")
-Rel_D(ecflow, fortiup, "calls program")
 
-Rel_D(yr, ingress, "rest (lvl 0)")
-Rel_D(api_met_no, ingress, "rest (lvl 0)")
-Rel_D(pingdom, ingress, "https (lvl 0)")
+  Rel(client, frontends, "http")
+  Rel(frontends, correctedforecaster, "grpc")
+  Rel(correctedforecaster, rawdataforecaster, "grpc")
 
-@enduml```
+  Rel(dataloader, objectstore, "Upload forecast data")
+  Rel(correctedforecaster, objectstore, "Download topography")
+  Rel(rawdataforecaster, objectstore, "Read forecast data")
+```